interface
BuildingFloorOptions
Options for a floor's plan in the realty scene.
icon?
An icon to add to the floors' control.
id
An identifier of the floor's plan.
isUnderground?
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?
A list of groups of labels connected with the floor's plan.
mapOptions?
Map's options to apply after selecting the particular floor.
modelUrl
A URL of a model that represents the current floor's plan.
text
A text to add to the floors' control.
BuildingOptions
Options for a building in the realty scene.
coordinates
Geographical coordinates [longitude, latitude].
floors?
A list of the floors' plans connected with the particular building.
interactive?
Interactivity of a model. The model isn't interactive by default.
linkedIds?
A list of buildings' identifiers that should be hidden.
mapOptions?
Map's options to apply after selecting the particular building.
maxZoom?
Maximum display styleZoom of the model.
minZoom?
Minimum display styleZoom of the model.
modelId
An identifier of a model should be unique for every model.
modelUrl
URL where a model is located.
offsetX?
Offset of a model along the X axis in meters.
offsetY?
Offset of a model along the Y axis in meters.
offsetZ?
Offset of a model along the Z axis in meters.
popupOptions?
Popup options.
rotateX?
Rotation of a model in degrees about the X axis.
rotateY?
Rotation of a model in degrees about the Y axis.
rotateZ?
Rotation of a model in degrees about the Z axis.
scale?
Scale of a model.
userData?
User specific data.
BuildingState
State for the building's scene.
ControlOptions
Control initialization options.
position
A position of the control.
GltfPluginEventTable
List of events that can be emitted by the GLTF plugin instance.
GltfPluginLabelEvent
Event type for pointer-related plugin events emitted by a label.
GltfPluginModelEvent
Event type for pointer-related plugin events emitted by a model.
HoverOptions
Options for the hover state of models.
color
A hover color.
LabelGroupDefaults
LabelGroupOptions
Options for a label group.
elevation
An elevation of a label group in meters.
fontColor?
A color of a label's font.
fontSize?
A size of a label's font.
id
An identifier of a label group to add.
image?
Image settings for labels' text background.
interactive?
Interactivity of a label group. The label group isn't interactive by default.
labels
An array of labels to add on the map
maxZoom?
A maximum display styleZoom of a label group.
minZoom?
A minimum display styleZoom of a label group.
LabelOptions
Options for a label.
LabelTarget
MapOptions
Options for the map.
ModelOptions
Options for a model.
coordinates
Geographical coordinates [longitude, latitude].
interactive?
Interactivity of a model. The model isn't interactive by default.
linkedIds?
A list of buildings' identifiers that should be hidden.
maxZoom?
Maximum display styleZoom of the model.
minZoom?
Minimum display styleZoom of the model.
modelId
An identifier of a model should be unique for every model.
modelUrl
URL where a model is located.
offsetX?
Offset of a model along the X axis in meters.
offsetY?
Offset of a model along the Y axis in meters.
offsetZ?
Offset of a model along the Z axis in meters.
rotateX?
Rotation of a model in degrees about the X axis.
rotateY?
Rotation of a model in degrees about the Y axis.
rotateZ?
Rotation of a model in degrees about the Z axis.
scale?
Scale of a model.
userData?
User specific data.
ModelTarget
PluginOptions
Options for the plugin.
floorsControl?
Settings for floors' control.
groundCoveringColor?
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?
Maximum display styleZoom for all models.
minZoom?
Minimum display styleZoom for all models.
modelsBaseUrl?
A URL which is used for resolving of a model's relative path.
modelsLoadStrategy?
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?
A distance to the camera the models get transparent from. It's set in units along Z axis of the WebGL space.
zIndex?
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.