Model
A layer to render 3D Models.
Parameters
the ID of the layer
the ID of the source
Constructors
Types
Functions
Bind the layer to the Style.
Bind the layer to the map controller.
A filter is a property at the layer level that determines which features should be rendered in a style layer.
The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.
Intensity of the ambient occlusion if present in the 3D model. Default value: 1. Value range: 0, 1
Set the ModelAmbientOcclusionIntensity property transition options
Enable/Disable shadow casting for this layer Default value: true.
The tint color of the model layer. model-color-mix-intensity (defaults to 0) defines tint(mix) intensity - this means that, this color is not used unless model-color-mix-intensity gets value greater than 0. Default value: "#ffffff".
Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix. Default value: 0. Value range: 0, 1
Set the ModelColorMixIntensity property transition options
DSL for modelColorMixIntensityTransition.
Set the ModelColor property transition options
DSL for modelColorTransition.
This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled. Default value: 0. Value range: 0, 1
Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source. Default value: 0. Value range: 0, 5
Set the ModelEmissiveStrength property transition options
DSL for modelEmissiveStrengthTransition.
An array for configuring the fade-out effect for the front cutoff of content on pitched map views. It contains three values: start, range and final opacity. The start parameter defines the point at which the fade-out effect begins, with smaller values causing the effect to start earlier. The range parameter specifies how long the fade-out effect will last. A value of 0.0 for range makes content disappear immediately without a fade-out effect. The final opacity determines content opacity at the end of the fade-out effect. A value of 1.0 for final opacity means that the cutoff is completely disabled. Default value: 0,0,1. Minimum value: 0,0,0. Maximum value: 1,1,1.
Emissive strength multiplier along model height (gradient begin, gradient end, value at begin, value at end, gradient curve power (logarithmic scale, curve power = pow(10, val)). Default value: 1,1,1,1,0.
Set the ModelHeightBasedEmissiveStrengthMultiplier property transition options
Model to render. It can be either a string referencing an element to the models root property or an internal or external URL Default value: "".
The opacity of the model layer. Default value: 1. Value range: 0, 1
Set the ModelOpacity property transition options
DSL for modelOpacityTransition.
Enable/Disable shadow receiving for this layer Default value: true.
The rotation of the model in euler angles lon, lat, z. Default value: 0,0,0.
Set the ModelRotation property transition options
DSL for modelRotationTransition.
Material roughness. Material is fully smooth for value 0, and fully rough for value 1. Affects only layers using batched-model source. Default value: 1. Value range: 0, 1
Set the ModelRoughness property transition options
DSL for modelRoughnessTransition.
The scale of the model. Default value: 1,1,1.
Defines scaling mode. Only applies to location-indicator type layers. Default value: "map".
Set the ModelScale property transition options
DSL for modelScaleTransition.
The translation of the model in meters in form of longitudal, latitudal, altitude offsets. Default value: 0,0,0.
Set the ModelTranslation property transition options
DSL for modelTranslationTransition.
Defines rendering behavior of model in respect to other 3D scene objects. Default value: "common-3d".
The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.
A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.
Whether this layer is displayed.
Properties
This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled. Default value: 0. Value range: 0, 1
This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled. Default value: 0. Value range: 0, 1
Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source. Default value: 0. Value range: 0, 5
Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source. Default value: 0. Value range: 0, 5
An array for configuring the fade-out effect for the front cutoff of content on pitched map views. It contains three values: start, range and final opacity. The start parameter defines the point at which the fade-out effect begins, with smaller values causing the effect to start earlier. The range parameter specifies how long the fade-out effect will last. A value of 0.0 for range makes content disappear immediately without a fade-out effect. The final opacity determines content opacity at the end of the fade-out effect. A value of 1.0 for final opacity means that the cutoff is completely disabled. Default value: 0,0,1. Minimum value: 0,0,0. Maximum value: 1,1,1.
An array for configuring the fade-out effect for the front cutoff of content on pitched map views. It contains three values: start, range and final opacity. The start parameter defines the point at which the fade-out effect begins, with smaller values causing the effect to start earlier. The range parameter specifies how long the fade-out effect will last. A value of 0.0 for range makes content disappear immediately without a fade-out effect. The final opacity determines content opacity at the end of the fade-out effect. A value of 1.0 for final opacity means that the cutoff is completely disabled. Default value: 0,0,1. Minimum value: 0,0,0. Maximum value: 1,1,1.