Interface BoxStyle

Altitude of the Box center in meters.

Describes the vertical distance from the global ground plane (0m) to the Box.

Supported values:

• false (default): place at 0m.
• true: use the altitude (z) from the feature geometry if present, else 0. Not re-aligned to the rendered terrain. If the geometry altitude source differs from the TerrainTileLayer source/resolution, the Box can appear slightly above or below the visible terrain surface.
• number: fixed absolute altitude in meters. Also not adjusted when terrain tiles load; may not perfectly sit on the terrain unless both use exactly the same elevation source, datum and resolution.
• 'terrain': sample (clamp to) the current terrain surface height. While the terrain tile is not yet loaded (or no terrain layer exists) the altitude is 0 and updates once data becomes available.

Notes:

• Use 'terrain' to keep the Box visually seated on the rendered terrain.
• Use a numeric value for a constant absolute elevation independent of terrain updates.
• To position something N meters above terrain: use 'terrain' plus offsetZ (e.g. offsetZ: '5m').
• Expect mismatches (floating / sinking) when using true or a fixed number with a different terrain data source.

The depth of the Box. The depth defines the length of the edges of a "Box" parallel to the Z axis. If the depth is not explicitly defined, the value of the "width" is used as the height.

Sets the emissive color of the "Box", giving it a glow effect.

Sets the color to fill the Box.

Controls the intensity of the fill color under directional lighting.

fillIntensity determines how much the "Box"'s fill color is affected by the directional lighting in the scene. A higher value increases the intensity of the fill color, making it more vibrant under strong lighting, while a lower value reduces the effect, resulting in a more muted color.

The value should range from 0 to 1, where 0 means no color intensity and 1 represents full intensity.

The Height of the Box. The unit of height is defined in pixels. If the height is not explicitly defined, the value of the width is used as the height.

Specifies the name of the light group to use for illuminating specific features on a layer. This property must reference a key corresponding to a light group defined in LayerStyle.lights. A light group consists of lighting sources such as ambient or directional lights that affect the appearance of features.

If light is not defined, the default light group "defaultLight" will be used to illuminate the layer's features.

Offset the Box in pixels on x-axis. A positive value offsets to the right, a negative value to the left. The default unit is pixels.

Offset the Box in pixels on y-axis. A positive value offsetY offsets downwards, a negative value upwards. The default unit is pixels.

Offset the Box in pixels on z-axis. A positive value offsets up, a negative value down. The default unit is pixels.

Defines the opacity of the style. The value must be between 0.0 (fully transparent) and 1.0 (fully opaque).

Controls perspective scaling of a Box's width, height, and depth based on altitude. When enabled, the Box's dimensions reflect its actual altitude. When disabled, they are scaled as if the Box were at ground level.

Box dimensions are pixel-based, so scaling is disabled by default and enabled by default when altitude resolves to "terrain".

Sets the shininess of the "Box", determining how glossy its surface appears. A higher value makes the "Box" surface more reflective.

Relationship with Specular

• Effect: The shininess value controls the size and intensity of the specular highlight, which is colored by the specular property.
• Specular Dependency: The shininess property enhances the effect of the specular color. If specular is not set, shininess has no visible effect.

Shininess Value Range and Effect

• Range: The shininess value typically ranges from 0 to 128.
• Low Values (0-10): Produce a wide, diffused highlight, resulting in a matte or dull appearance.
• High Values (50-128): Produce a small, intense highlight, resulting in a glossy or shiny appearance.

Sets the specular color of the "Box", affecting how it reflects light.

Relationship with Shininess

• Effect: The specular property determines the color of the light reflection, while the shininess value controls the intensity and size of the reflection.
• Shininess Dependency: If specular is set and shininess is not explicitly set, the default shininess value will be used to control the reflection's appearance.

Sets the stroke color of the Box.

Sets the width of the stroke. The unit of strokeWidth is defined in pixels.

Specifies the type of style to render.

The Width of the Box. The unit of width is defined in pixels.

Indicates the drawing order within a layer. Styles with larger zIndex value are rendered above those with smaller values. The zIndex is defined relative to the "zLayer" property. If "zLayer" is defined all zIndex values are relative to the "zLayer" value.

Indicates drawing order across multiple layers. Styles using zLayer with a high value are rendered on top of zLayers with a low value. If no zLayer is defined, it will fall back to the LayerStyle.zLayer or depend on the display layer order. The first (lowest) layer has a zLayer value of 1.