Skip to main content

interface

BuildingFloorOptions​

Options for a floor's plan in the realty scene.

Properties

icon?​

string

An icon to add to the floors' control.

id​

string

An 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.

labelGroups?​

LabelGroupOptions[]

A list of groups of labels connected with the floor's plan.

mapOptions?​

Map's options to apply after selecting the particular floor.

modelUrl​

string

A URL of a model that represents the current floor's plan.

text​

string

A text to add to the floors' control.

BuildingOptions​

Options for a building in the realty scene.

Properties

coordinates​

number[]

Geographical coordinates [longitude, latitude].

floors?​

BuildingFloorOptions[]

A list of the floors' plans connected with the particular building.

interactive?​

boolean

Interactivity of a model. The model isn't interactive by default.

linkedIds?​

string[]

A list of buildings' identifiers that should be hidden.

mapOptions?​

Map's options to apply after selecting the particular building.

maxZoom?​

number

Maximum display styleZoom of the model.

minZoom?​

number

Minimum display styleZoom of the model.

modelId​

string

An identifier of a model should be unique for every model.

modelUrl​

string

URL where a model is located.

offsetX?​

number

Offset of a model along the X axis in meters.

offsetY?​

number

Offset of a model along the Y axis in meters.

offsetZ?​

number

Offset of a model along the Z axis in meters.

popupOptions?​

Popup options.

rotateX?​

number

Rotation of a model in degrees about the X axis.

rotateY?​

number

Rotation of a model in degrees about the Y axis.

rotateZ?​

number

Rotation of a model in degrees about the Z axis.

scale?​

number

Scale of a model.

userData?​

any

User specific data.

BuildingState​

State for the building's scene.

Properties

buildingId​

string

An identifier of the building's model.

floorId?​

string

An identifier of the floor's model.

ControlOptions​

Control initialization options.

Properties

position​

A position of the control.

GltfPluginEventTable​

List of events that can be emitted by the GLTF plugin instance.

Properties

click​

Emitted when a model or a label is clicked.

mousemove​

Emitted when user moves pointer over a model or a label.

mouseout​

Emitted when user moves mouse away from a model or a label.

mouseover​

Emitted when user hovers over a model or a label.

GltfPluginLabelEvent​

Event type for pointer-related plugin events emitted by a label.

Properties

lngLat​

number[]

Geographical coordinates of an event.

originalEvent​

MouseEvent<>|TouchEvent<>

An original DOM event.

point​

number[]

Screen coordinates of an event.

target​

A target of a label event.

GltfPluginModelEvent​

Event type for pointer-related plugin events emitted by a model.

Properties

lngLat​

number[]

Geographical coordinates of an event.

originalEvent​

MouseEvent<>|TouchEvent<>

An original DOM event.

point​

number[]

Screen coordinates of an event.

target​

A target of a model event.

HoverOptions​

Options for the hover state of models.

Properties

color​

string

A hover color.

LabelGroupDefaults​

Properties

fontColor?​

string

A font color of labels in a group.

fontSize?​

number

A font size of labels in a group.

image?​

LabelImage

Image settings for a text background of labels in a group.

LabelGroupOptions​

Options for a label group.

Properties

elevation​

number

An elevation of a label group in meters.

fontColor?​

string

A color of a label's font.

fontSize?​

number

A size of a label's font.

id​

string

An identifier of a label group to add.

image?​

LabelImage|"default"

Image settings for labels' text background.

interactive?​

boolean

Interactivity of a label group. The label group isn't interactive by default.

labels​

LabelOptions[]

An array of labels to add on the map

maxZoom?​

number

A maximum display styleZoom of a label group.

minZoom?​

number

A minimum display styleZoom of a label group.

LabelOptions​

Options for a label.

Properties

coordinates​

[number, number]

Coordinates of a label.

elevation?​

number

An elevation of a label in meters.

interactive?​

boolean

Interactivity of a label. The label isn't interactive by default.

text​

string

A text of a label.

userData?​

any

User specific data.

LabelTarget​

Properties

buildingId?​

string

An identifier of the building's model.

data​

A targeted label.

floorId?​

string

An identifier of the current floor.

type​

"label"

The type of a target.

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 a model. The model isn't interactive by default.

linkedIds?​

string[]

A list of buildings' identifiers that should be hidden.

maxZoom?​

number

Maximum display styleZoom of the model.

minZoom?​

number

Minimum display styleZoom of the model.

modelId​

string

An identifier of a model should be unique for every model.

modelUrl​

string

URL where a model is located.

offsetX?​

number

Offset of a model along the X axis in meters.

offsetY?​

number

Offset of a model along the Y axis in meters.

offsetZ?​

number

Offset of a model along the Z axis in meters.

rotateX?​

number

Rotation of a model in degrees about the X axis.

rotateY?​

number

Rotation of a model in degrees about the Y axis.

rotateZ?​

number

Rotation of a model in degrees about the Z axis.

scale?​

number

Scale of a model.

userData?​

any

User specific data.

ModelTarget​

Properties

data​

A targeted model.

modelId​

string

An identifier of the building's or floor's model.

type​

"model"

The type of a target.

PluginOptions​

Options for the plugin.

Properties

floorsControl?​

Settings for floors' control.

groundCoveringColor?​

string

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

hoverOptions?​

Settings of hovered models.

labelGroupDefaults?​

Defaults for any label group used when such options aren't specified in label group options directly.

maxZoom?​

number

Maximum display styleZoom for all models.

minZoom?​

number

Minimum display styleZoom for all models.

modelsBaseUrl?​

string

A URL which is used for resolving of a model's relative path.

modelsLoadStrategy?​

"dontWaitAll"|"waitAll"

Strategies for loading and rendering of models:

  • dontWaitAll - show every model on its loading completion. In case of a realty scene it allows to download less data and show every model in the scene as soon as possible, but there will be a delay between switching floor plans if they are not loaded.
  • waitAll - show models only when all models are loaded. In case of a realty scene it leads to an increase in amount of loaded data and time of rendering scene, but it allows to avoid a delay between switching floor plans.

modelsNearCameraFade?​

number

A distance to the camera the models get transparent from. It's set in units along Z axis of the WebGL space.

zIndex?​

number

Draw order of plugin objects (models and labels). It may be useful when other map objects (such as markers, shapes, etc.) need to be added on the map so that user could manage draw order of the plugin and these objects.

Options of popup that appears on hover of buildings.

Properties
number[]

Popup's coordinates.

string

A popup's description.

string

A popup's title.