Skip to main content

interface

AmbientLightOptions​

Options for an ambient light

Properties

color​

Color of the ambient light.

intencity​

number

Numeric value of the light's strength/intensity.

BuildingFloorOptions​

Options for a floor's plan on the realty scene

Properties

icon?​

string

Icon to add to the floors' control

id​

Identifier of the floor's plan

isUnderground?​

boolean

Specifies whether a floor's plan is underground. If value is true the map will be covered with a ground geometry so that only the floor's plan will stay visible.

mapOptions?​

Map's options to apply after selecting the particular floor

modelUrl​

string

Url of a model that represents the current floor's plan

poiGroups?​

PoiGroupOptions[]

List of poi groups connected with the floor's plan

text​

string

Text to add to the floors' control

BuildingOptions​

Options for a building on the realty scene

Properties

coordinates​

number[]

Geographical coordinates [longitude, latitude]

floors?​

BuildingFloorOptions[]

List of the floors' plans connected with the particular building

interactive?​

boolean

Interactivity of model. All models are interactive by default

linkedIds?​

string[]

List of buildings' identifiers that should be hidden

mapOptions?​

Map's options to apply after selecting the particular building

modelId​

Identifier of the model should be unique for every model

modelUrl​

string

Url where the model is located

offsetX?​

number

Offset of the model along the X axis in meters

offsetY?​

number

Offset of the model along the Y axis in meters

offsetZ?​

number

Offset of the model along the Z axis in meters

popupOptions?​

Popup options

rotateX?​

number

Rotation of the model in degrees about the X axis

rotateY?​

number

Rotation of the model in degrees about the Y axis

rotateZ?​

number

Rotation of the model in degrees about the Z axis

scale?​

number

Scale of the model

userData?​

any

User specific data

BuildingState​

State for the building's scene

Properties

floorId?​

Identifier of the floor's model

modelId​

Identifier of the building's model

ControlOptions​

Control initialization options.

Properties

position​

Position of the control.

GltfPluginEventTable​

The list of events that can be emitted by the glTF plugin instance

Properties

click​

Emitted when model or poi are clicked

mousemove​

Emitted when the user moves the pointer over the model or the poi

mouseout​

Emitted when the user moves the mouse away from the model or the poi

mouseover​

Emitted when the user hovers over the model or the poi

GltfPluginModelEvent​

The event type for pointer-related plugin events emitted by the model

Properties

lngLat​

number[]

Geographical coordinates of the event

originalEvent​

MouseEvent<>|TouchEvent<>

The original DOM event

point​

number[]

Screen coordinates of the event

target​

Target of the model event

GltfPluginPoiEvent​

The event type for pointer-related plugin events emitted by the poi

Properties

lngLat​

number[]

Geographical coordinates of the event

originalEvent​

MouseEvent<>|TouchEvent<>

The original DOM event

point​

number[]

Screen coordinates of the event

target​

Target of the poi event

HightlightOptions​

Options for the highlight color of hovered models

Properties

color?​

Color of the hover

intencity​

number

Intensity of the color on the hover in the range from 0 to 1

MapOptions​

Options for the map

Properties

center?​

number[]

Geographical center of the map

pitch?​

number

Map's pitch angle in degrees

rotation?​

number

Map's rotation angle in degrees

zoom?​

number

Map's zoom

ModelOptions​

Options for a model

Properties

coordinates​

number[]

Geographical coordinates [longitude, latitude]

interactive?​

boolean

Interactivity of model. All models are interactive by default

linkedIds?​

string[]

List of buildings' identifiers that should be hidden

modelId​

Identifier of the model should be unique for every model

modelUrl​

string

Url where the model is located

offsetX?​

number

Offset of the model along the X axis in meters

offsetY?​

number

Offset of the model along the Y axis in meters

offsetZ?​

number

Offset of the model along the Z axis in meters

rotateX?​

number

Rotation of the model in degrees about the X axis

rotateY?​

number

Rotation of the model in degrees about the Y axis

rotateZ?​

number

Rotation of the model in degrees about the Z axis

scale?​

number

Scale of the model

userData?​

any

User specific data

ModelTarget​

Properties

data​

The targeted model

floorId?​

Identifier of the current floor

modelId?​

Identifier of the building's model

type​

"model"

Type of the target

PluginOptions​

Options for the plugin

Properties

ambientLight?​

Settings for an ambient light

dracoScriptsUrl?​

string

The url where scripts for the draco decoder are located

floorsControl?​

Settings for floors' control

groundCoveringColor?​

string

Color for the ground covering when an underground floor's plan is shown.

hoverHighlight?​

Settings of the highlighted models

modelsBaseUrl?​

string

The url which is used for resolving of a model's relative url

modelsLoadStrategy?​

"dontWaitAll"|"waitAll"

Strategies for the loading of models:

  • dontWaitAll - show models as soon as possible
  • waitAll - show models only when all models are ready for the rendering

poiConfig?​

Configuration of poi

PoiConfig​

Properties

primary?​

Configuration the primary poi

secondary?​

Configuration the secondary poi

PoiConfigGranular​

Configuration of the poi

Properties

fontColor?​

string

Color of the font

fontSize?​

number

Size of the font

PoiGroupOptions​

Options for a poi group

Properties

data​

PoiOptions[]

Array of poi to add on the map

elevation​

number

Elevation of the group of poi

fontColor?​

string

Color of the poi's font

fontSize?​

number

Size of the poi's font

id​

Identifier of the poi group to add

maxZoom?​

number

Maximum display styleZoom of the poi group

minZoom?​

number

Minimum display styleZoom of the poi group

type​

"primary"|"secondary"

Type of the poi

PoiOptions​

Options for a poi

Properties

coordinates​

[number, number]

Coordinate of the poi

elevation?​

number

Elevation of the poi

label​

string

Elevation of the poi

userData?​

any

User specific data

PoiTarget​

Properties

data​

The targeted poi

floorId?​

Identifier of the current floor

modelId?​

Identifier of the building's model

type​

"poi"

Type of the target

Options of popup that appears on hover of buildings

Properties
number[]

Popup's coordinates

string

Popup's description

string

Popup's title