Package-level declarations

data class TextAnchorValue(val value: Value)

Part of the text placed closest to the anchor. Default value: "center".

TextJustifyValue

data class TextJustifyValue(val value: Value)

Text justification options. Default value: "center".

TextPitchAlignmentValue

TextRotationAlignmentValue

data class TextPitchAlignmentValue(val value: Value)

Orientation of text when map is pitched. Default value: "auto".

data class TextRotationAlignmentValue(val value: Value)

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".

TextTransformValue

data class TextTransformValue(val value: Value)

Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".

TextTranslateAnchorValue

data class TextTranslateAnchorValue(val value: Value)

Controls the frame of reference for text-translate. Default value: "map".

TextVariableAnchor

TextVariableAnchorListValue

data class TextVariableAnchor

To increase the chance of placing high-priority labels on the map, you can provide an array of text-anchor locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use text-justify: auto to choose justification based on anchor position. To apply an offset, use the text-radial-offset or the two-dimensional text-offset.

data class TextVariableAnchorListValue(val value: Value)

TextWritingMode

data class TextWritingMode

The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either 'horizontal', 'vertical' or 'vertical', 'horizontal', the order doesn't affect the placement.

TextWritingModeListValue

data class TextWritingModeListValue(val value: Value)

VisibilityValue

data class VisibilityValue(val value: Value)

Whether this layer is displayed. Default value: "visible".

Functions

BackgroundLayer

fun BackgroundLayer(layerId: String = remember { generateRandomLayerId("background") }, backgroundColor: ColorValue = ColorValue.INITIAL, backgroundColorTransition: Transition = Transition.INITIAL, backgroundEmissiveStrength: DoubleValue = DoubleValue.INITIAL, backgroundEmissiveStrengthTransition: Transition = Transition.INITIAL, backgroundOpacity: DoubleValue = DoubleValue.INITIAL, backgroundOpacityTransition: Transition = Transition.INITIAL, backgroundPattern: ImageValue = ImageValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL)

The background color or pattern of the map.

CircleLayer

fun CircleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("circle") }, circleSortKey: DoubleValue = DoubleValue.INITIAL, circleBlur: DoubleValue = DoubleValue.INITIAL, circleBlurTransition: Transition = Transition.INITIAL, circleColor: ColorValue = ColorValue.INITIAL, circleColorTransition: Transition = Transition.INITIAL, circleEmissiveStrength: DoubleValue = DoubleValue.INITIAL, circleEmissiveStrengthTransition: Transition = Transition.INITIAL, circleOpacity: DoubleValue = DoubleValue.INITIAL, circleOpacityTransition: Transition = Transition.INITIAL, circlePitchAlignment: CirclePitchAlignmentValue = CirclePitchAlignmentValue.INITIAL, circlePitchScale: CirclePitchScaleValue = CirclePitchScaleValue.INITIAL, circleRadius: DoubleValue = DoubleValue.INITIAL, circleRadiusTransition: Transition = Transition.INITIAL, circleStrokeColor: ColorValue = ColorValue.INITIAL, circleStrokeColorTransition: Transition = Transition.INITIAL, circleStrokeOpacity: DoubleValue = DoubleValue.INITIAL, circleStrokeOpacityTransition: Transition = Transition.INITIAL, circleStrokeWidth: DoubleValue = DoubleValue.INITIAL, circleStrokeWidthTransition: Transition = Transition.INITIAL, circleTranslate: DoubleListValue = DoubleListValue.INITIAL, circleTranslateTransition: Transition = Transition.INITIAL, circleTranslateAnchor: CircleTranslateAnchorValue = CircleTranslateAnchorValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A filled circle.

FillExtrusionLayer

fun FillExtrusionLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill-extrusion") }, fillExtrusionEdgeRadius: DoubleValue = DoubleValue.INITIAL, fillExtrusionAmbientOcclusionGroundAttenuation: DoubleValue = DoubleValue.INITIAL, fillExtrusionAmbientOcclusionGroundAttenuationTransition: Transition = Transition.INITIAL, fillExtrusionAmbientOcclusionGroundRadius: DoubleValue = DoubleValue.INITIAL, fillExtrusionAmbientOcclusionGroundRadiusTransition: Transition = Transition.INITIAL, fillExtrusionAmbientOcclusionIntensity: DoubleValue = DoubleValue.INITIAL, fillExtrusionAmbientOcclusionIntensityTransition: Transition = Transition.INITIAL, fillExtrusionAmbientOcclusionRadius: DoubleValue = DoubleValue.INITIAL, fillExtrusionAmbientOcclusionRadiusTransition: Transition = Transition.INITIAL, fillExtrusionAmbientOcclusionWallRadius: DoubleValue = DoubleValue.INITIAL, fillExtrusionAmbientOcclusionWallRadiusTransition: Transition = Transition.INITIAL, fillExtrusionBase: DoubleValue = DoubleValue.INITIAL, fillExtrusionBaseTransition: Transition = Transition.INITIAL, fillExtrusionColor: ColorValue = ColorValue.INITIAL, fillExtrusionColorTransition: Transition = Transition.INITIAL, fillExtrusionCutoffFadeRange: DoubleValue = DoubleValue.INITIAL, fillExtrusionEmissiveStrength: DoubleValue = DoubleValue.INITIAL, fillExtrusionEmissiveStrengthTransition: Transition = Transition.INITIAL, fillExtrusionFloodLightColor: ColorValue = ColorValue.INITIAL, fillExtrusionFloodLightColorTransition: Transition = Transition.INITIAL, fillExtrusionFloodLightGroundAttenuation: DoubleValue = DoubleValue.INITIAL, fillExtrusionFloodLightGroundAttenuationTransition: Transition = Transition.INITIAL, fillExtrusionFloodLightGroundRadius: DoubleValue = DoubleValue.INITIAL, fillExtrusionFloodLightGroundRadiusTransition: Transition = Transition.INITIAL, fillExtrusionFloodLightIntensity: DoubleValue = DoubleValue.INITIAL, fillExtrusionFloodLightIntensityTransition: Transition = Transition.INITIAL, fillExtrusionFloodLightWallRadius: DoubleValue = DoubleValue.INITIAL, fillExtrusionFloodLightWallRadiusTransition: Transition = Transition.INITIAL, fillExtrusionHeight: DoubleValue = DoubleValue.INITIAL, fillExtrusionHeightTransition: Transition = Transition.INITIAL, fillExtrusionOpacity: DoubleValue = DoubleValue.INITIAL, fillExtrusionOpacityTransition: Transition = Transition.INITIAL, fillExtrusionPattern: ImageValue = ImageValue.INITIAL, fillExtrusionRoundedRoof: BooleanValue = BooleanValue.INITIAL, fillExtrusionTranslate: DoubleListValue = DoubleListValue.INITIAL, fillExtrusionTranslateTransition: Transition = Transition.INITIAL, fillExtrusionTranslateAnchor: FillExtrusionTranslateAnchorValue = FillExtrusionTranslateAnchorValue.INITIAL, fillExtrusionVerticalGradient: BooleanValue = BooleanValue.INITIAL, fillExtrusionVerticalScale: DoubleValue = DoubleValue.INITIAL, fillExtrusionVerticalScaleTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

An extruded (3D) polygon.

FillLayer

fun FillLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("fill") }, fillSortKey: DoubleValue = DoubleValue.INITIAL, fillAntialias: BooleanValue = BooleanValue.INITIAL, fillColor: ColorValue = ColorValue.INITIAL, fillColorTransition: Transition = Transition.INITIAL, fillEmissiveStrength: DoubleValue = DoubleValue.INITIAL, fillEmissiveStrengthTransition: Transition = Transition.INITIAL, fillOpacity: DoubleValue = DoubleValue.INITIAL, fillOpacityTransition: Transition = Transition.INITIAL, fillOutlineColor: ColorValue = ColorValue.INITIAL, fillOutlineColorTransition: Transition = Transition.INITIAL, fillPattern: ImageValue = ImageValue.INITIAL, fillTranslate: DoubleListValue = DoubleListValue.INITIAL, fillTranslateTransition: Transition = Transition.INITIAL, fillTranslateAnchor: FillTranslateAnchorValue = FillTranslateAnchorValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A filled polygon with an optional stroked border.

HeatmapLayer

fun HeatmapLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("heatmap") }, heatmapColor: ColorValue = ColorValue.INITIAL, heatmapIntensity: DoubleValue = DoubleValue.INITIAL, heatmapIntensityTransition: Transition = Transition.INITIAL, heatmapOpacity: DoubleValue = DoubleValue.INITIAL, heatmapOpacityTransition: Transition = Transition.INITIAL, heatmapRadius: DoubleValue = DoubleValue.INITIAL, heatmapRadiusTransition: Transition = Transition.INITIAL, heatmapWeight: DoubleValue = DoubleValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A heatmap.

HillshadeLayer

fun HillshadeLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("hillshade") }, hillshadeAccentColor: ColorValue = ColorValue.INITIAL, hillshadeAccentColorTransition: Transition = Transition.INITIAL, hillshadeEmissiveStrength: DoubleValue = DoubleValue.INITIAL, hillshadeEmissiveStrengthTransition: Transition = Transition.INITIAL, hillshadeExaggeration: DoubleValue = DoubleValue.INITIAL, hillshadeExaggerationTransition: Transition = Transition.INITIAL, hillshadeHighlightColor: ColorValue = ColorValue.INITIAL, hillshadeHighlightColorTransition: Transition = Transition.INITIAL, hillshadeIlluminationAnchor: HillshadeIlluminationAnchorValue = HillshadeIlluminationAnchorValue.INITIAL, hillshadeIlluminationDirection: DoubleValue = DoubleValue.INITIAL, hillshadeShadowColor: ColorValue = ColorValue.INITIAL, hillshadeShadowColorTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.

LineLayer

fun LineLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("line") }, lineCap: LineCapValue = LineCapValue.INITIAL, lineJoin: LineJoinValue = LineJoinValue.INITIAL, lineMiterLimit: DoubleValue = DoubleValue.INITIAL, lineRoundLimit: DoubleValue = DoubleValue.INITIAL, lineSortKey: DoubleValue = DoubleValue.INITIAL, lineZOffset: DoubleValue = DoubleValue.INITIAL, lineBlur: DoubleValue = DoubleValue.INITIAL, lineBlurTransition: Transition = Transition.INITIAL, lineBorderColor: ColorValue = ColorValue.INITIAL, lineBorderColorTransition: Transition = Transition.INITIAL, lineBorderWidth: DoubleValue = DoubleValue.INITIAL, lineBorderWidthTransition: Transition = Transition.INITIAL, lineColor: ColorValue = ColorValue.INITIAL, lineColorTransition: Transition = Transition.INITIAL, lineDasharray: DoubleListValue = DoubleListValue.INITIAL, lineDepthOcclusionFactor: DoubleValue = DoubleValue.INITIAL, lineDepthOcclusionFactorTransition: Transition = Transition.INITIAL, lineEmissiveStrength: DoubleValue = DoubleValue.INITIAL, lineEmissiveStrengthTransition: Transition = Transition.INITIAL, lineGapWidth: DoubleValue = DoubleValue.INITIAL, lineGapWidthTransition: Transition = Transition.INITIAL, lineGradient: ColorValue = ColorValue.INITIAL, lineOcclusionOpacity: DoubleValue = DoubleValue.INITIAL, lineOcclusionOpacityTransition: Transition = Transition.INITIAL, lineOffset: DoubleValue = DoubleValue.INITIAL, lineOffsetTransition: Transition = Transition.INITIAL, lineOpacity: DoubleValue = DoubleValue.INITIAL, lineOpacityTransition: Transition = Transition.INITIAL, linePattern: ImageValue = ImageValue.INITIAL, lineTranslate: DoubleListValue = DoubleListValue.INITIAL, lineTranslateTransition: Transition = Transition.INITIAL, lineTranslateAnchor: LineTranslateAnchorValue = LineTranslateAnchorValue.INITIAL, lineTrimOffset: DoubleListValue = DoubleListValue.INITIAL, lineWidth: DoubleValue = DoubleValue.INITIAL, lineWidthTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A stroked line.

LocationIndicatorLayer

fun LocationIndicatorLayer(layerId: String = remember { generateRandomLayerId("location-indicator") }, bearingImage: ImageValue = ImageValue.INITIAL, shadowImage: ImageValue = ImageValue.INITIAL, topImage: ImageValue = ImageValue.INITIAL, accuracyRadius: DoubleValue = DoubleValue.INITIAL, accuracyRadiusTransition: Transition = Transition.INITIAL, accuracyRadiusBorderColor: ColorValue = ColorValue.INITIAL, accuracyRadiusBorderColorTransition: Transition = Transition.INITIAL, accuracyRadiusColor: ColorValue = ColorValue.INITIAL, accuracyRadiusColorTransition: Transition = Transition.INITIAL, bearing: DoubleValue = DoubleValue.INITIAL, bearingTransition: Transition = Transition.INITIAL, bearingImageSize: DoubleValue = DoubleValue.INITIAL, bearingImageSizeTransition: Transition = Transition.INITIAL, emphasisCircleColor: ColorValue = ColorValue.INITIAL, emphasisCircleColorTransition: Transition = Transition.INITIAL, emphasisCircleRadius: DoubleValue = DoubleValue.INITIAL, emphasisCircleRadiusTransition: Transition = Transition.INITIAL, imagePitchDisplacement: DoubleValue = DoubleValue.INITIAL, location: DoubleListValue = DoubleListValue.INITIAL, locationTransition: Transition = Transition.INITIAL, locationIndicatorOpacity: DoubleValue = DoubleValue.INITIAL, locationIndicatorOpacityTransition: Transition = Transition.INITIAL, perspectiveCompensation: DoubleValue = DoubleValue.INITIAL, shadowImageSize: DoubleValue = DoubleValue.INITIAL, shadowImageSizeTransition: Transition = Transition.INITIAL, topImageSize: DoubleValue = DoubleValue.INITIAL, topImageSizeTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

Location Indicator layer.

ModelLayer

fun ModelLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("model") }, modelId: ModelIdValue = ModelIdValue.INITIAL, modelAmbientOcclusionIntensity: DoubleValue = DoubleValue.INITIAL, modelAmbientOcclusionIntensityTransition: Transition = Transition.INITIAL, modelCastShadows: BooleanValue = BooleanValue.INITIAL, modelColor: ColorValue = ColorValue.INITIAL, modelColorTransition: Transition = Transition.INITIAL, modelColorMixIntensity: DoubleValue = DoubleValue.INITIAL, modelColorMixIntensityTransition: Transition = Transition.INITIAL, modelCutoffFadeRange: DoubleValue = DoubleValue.INITIAL, modelEmissiveStrength: DoubleValue = DoubleValue.INITIAL, modelEmissiveStrengthTransition: Transition = Transition.INITIAL, modelFrontCutoff: DoubleListValue = DoubleListValue.INITIAL, modelHeightBasedEmissiveStrengthMultiplier: DoubleListValue = DoubleListValue.INITIAL, modelHeightBasedEmissiveStrengthMultiplierTransition: Transition = Transition.INITIAL, modelOpacity: DoubleValue = DoubleValue.INITIAL, modelOpacityTransition: Transition = Transition.INITIAL, modelReceiveShadows: BooleanValue = BooleanValue.INITIAL, modelRotation: DoubleListValue = DoubleListValue.INITIAL, modelRotationTransition: Transition = Transition.INITIAL, modelRoughness: DoubleValue = DoubleValue.INITIAL, modelRoughnessTransition: Transition = Transition.INITIAL, modelScale: DoubleListValue = DoubleListValue.INITIAL, modelScaleTransition: Transition = Transition.INITIAL, modelScaleMode: ModelScaleModeValue = ModelScaleModeValue.INITIAL, modelTranslation: DoubleListValue = DoubleListValue.INITIAL, modelTranslationTransition: Transition = Transition.INITIAL, modelType: ModelTypeValue = ModelTypeValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A layer to render 3D Models.

RasterLayer

fun RasterLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster") }, rasterArrayBand: StringValue = StringValue.INITIAL, rasterBrightnessMax: DoubleValue = DoubleValue.INITIAL, rasterBrightnessMaxTransition: Transition = Transition.INITIAL, rasterBrightnessMin: DoubleValue = DoubleValue.INITIAL, rasterBrightnessMinTransition: Transition = Transition.INITIAL, rasterColor: ColorValue = ColorValue.INITIAL, rasterColorMix: DoubleListValue = DoubleListValue.INITIAL, rasterColorMixTransition: Transition = Transition.INITIAL, rasterColorRange: DoubleRangeValue = DoubleRangeValue.INITIAL, rasterColorRangeTransition: Transition = Transition.INITIAL, rasterContrast: DoubleValue = DoubleValue.INITIAL, rasterContrastTransition: Transition = Transition.INITIAL, rasterElevation: DoubleValue = DoubleValue.INITIAL, rasterElevationTransition: Transition = Transition.INITIAL, rasterEmissiveStrength: DoubleValue = DoubleValue.INITIAL, rasterEmissiveStrengthTransition: Transition = Transition.INITIAL, rasterFadeDuration: DoubleValue = DoubleValue.INITIAL, rasterHueRotate: DoubleValue = DoubleValue.INITIAL, rasterHueRotateTransition: Transition = Transition.INITIAL, rasterOpacity: DoubleValue = DoubleValue.INITIAL, rasterOpacityTransition: Transition = Transition.INITIAL, rasterResampling: RasterResamplingValue = RasterResamplingValue.INITIAL, rasterSaturation: DoubleValue = DoubleValue.INITIAL, rasterSaturationTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

Raster map textures such as satellite imagery.

RasterParticleLayer

fun RasterParticleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster-particle") }, rasterParticleArrayBand: StringValue = StringValue.INITIAL, rasterParticleColor: ColorValue = ColorValue.INITIAL, rasterParticleCount: LongValue = LongValue.INITIAL, rasterParticleFadeOpacityFactor: DoubleValue = DoubleValue.INITIAL, rasterParticleFadeOpacityFactorTransition: Transition = Transition.INITIAL, rasterParticleMaxSpeed: DoubleValue = DoubleValue.INITIAL, rasterParticleResetRateFactor: DoubleValue = DoubleValue.INITIAL, rasterParticleSpeedFactor: DoubleValue = DoubleValue.INITIAL, rasterParticleSpeedFactorTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

Particle animation driven by textures such as wind maps.

SkyLayer

fun SkyLayer(layerId: String = remember { generateRandomLayerId("sky") }, skyAtmosphereColor: ColorValue = ColorValue.INITIAL, skyAtmosphereHaloColor: ColorValue = ColorValue.INITIAL, skyAtmosphereSun: DoubleListValue = DoubleListValue.INITIAL, skyAtmosphereSunIntensity: DoubleValue = DoubleValue.INITIAL, skyGradient: ColorValue = ColorValue.INITIAL, skyGradientCenter: DoubleListValue = DoubleListValue.INITIAL, skyGradientRadius: DoubleValue = DoubleValue.INITIAL, skyOpacity: DoubleValue = DoubleValue.INITIAL, skyOpacityTransition: Transition = Transition.INITIAL, skyType: SkyTypeValue = SkyTypeValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A spherical dome around the map that is always rendered behind all other layers.

SymbolLayer