Package com.mapbox.mapboxsdk.style.layers
Contains the Mapbox Maps Android Style Layer API classes.
Types
Name | Summary |
---|---|
BackgroundLayer | @UiThread() open class BackgroundLayer : Layer The background color or pattern of the map. |
CannotAddLayerException | open class CannotAddLayerException : RuntimeException Thrown when adding a layer to a map twice |
CircleLayer | @UiThread() open class CircleLayer : Layer A filled circle. |
CustomLayer | open class CustomLayer : Layer Custom layer. |
FillExtrusionLayer | @UiThread() open class FillExtrusionLayer : Layer An extruded (3D) polygon. |
FillLayer | @UiThread() open class FillLayer : Layer A filled polygon with an optional stroked border. |
HeatmapLayer | @UiThread() open class HeatmapLayer : Layer A heatmap. |
HillshadeLayer | @UiThread() open class HillshadeLayer : Layer Client-side hillshading visualization based on DEM data. |
Layer | abstract class Layer Base class for the different Layer types |
LayoutPropertyValue | open class LayoutPropertyValue<T> : PropertyValue<T> |
LineLayer | @UiThread() open class LineLayer : Layer A stroked line. |
PaintPropertyValue | open class PaintPropertyValue<T> : PropertyValue<T> |
Property | class Property Paint/Layout properties for Layer |
PropertyFactory | open class PropertyFactory Constructs paint/layout properties for Layers |
PropertyValue | open class PropertyValue<T> Properties for Layer |
RasterLayer | @UiThread() open class RasterLayer : Layer Raster map textures such as satellite imagery. |
SymbolLayer | @UiThread() open class SymbolLayer : Layer An icon or a text label. |
TransitionOptions | open class TransitionOptions Resembles transition property from the style specification. |
BackgroundLayer
@UiThread()
open class BackgroundLayer : Layer
The background color or pattern of the map.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
BackgroundLayer | open fun BackgroundLayer(nativePtr: Long)Creates a BackgroundLayer. |
BackgroundLayer | open fun BackgroundLayer(layerId: String)Creates a BackgroundLayer. |
Functions
Name | Summary |
---|---|
getBackgroundColor | @NonNull() open fun getBackgroundColor(): PropertyValue Get the BackgroundColor property |
getBackgroundColorAsInt | open fun getBackgroundColorAsInt(): Int The color with which the background will be drawn. |
getBackgroundColorTransition | @NonNull() open fun getBackgroundColorTransition(): TransitionOptions Get the BackgroundColor property transition options |
getBackgroundOpacity | @NonNull() open fun getBackgroundOpacity(): PropertyValue Get the BackgroundOpacity property |
getBackgroundOpacityTransition | @NonNull() open fun getBackgroundOpacityTransition(): TransitionOptions Get the BackgroundOpacity property transition options |
getBackgroundPattern | @NonNull() open fun getBackgroundPattern(): PropertyValue Get the BackgroundPattern property |
getBackgroundPatternTransition | @NonNull() open fun getBackgroundPatternTransition(): TransitionOptions Get the BackgroundPattern property transition options |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setBackgroundColorTransition | open fun setBackgroundColorTransition(options: TransitionOptions) Set the BackgroundColor property transition options |
setBackgroundOpacityTransition | open fun setBackgroundOpacityTransition(options: TransitionOptions) Set the BackgroundOpacity property transition options |
setBackgroundPatternTransition | open fun setBackgroundPatternTransition(options: TransitionOptions) Set the BackgroundPattern property transition options |
setDetached | open fun setDetached() |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
getBackgroundColorAsInt
open fun getBackgroundColorAsInt(): Int
The color with which the background will be drawn.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getBackgroundColorTransition
@NonNull()
open fun getBackgroundColorTransition(): TransitionOptions
Get the BackgroundColor property transition options
Return
transition options for String
getBackgroundColor
@NonNull()
open fun getBackgroundColor(): PropertyValue
Get the BackgroundColor property
Return
property wrapper value around String
getBackgroundOpacityTransition
@NonNull()
open fun getBackgroundOpacityTransition(): TransitionOptions
Get the BackgroundOpacity property transition options
Return
transition options for Float
getBackgroundOpacity
@NonNull()
open fun getBackgroundOpacity(): PropertyValue
Get the BackgroundOpacity property
Return
property wrapper value around Float
getBackgroundPatternTransition
@NonNull()
open fun getBackgroundPatternTransition(): TransitionOptions
Get the BackgroundPattern property transition options
Return
transition options for String
getBackgroundPattern
@NonNull()
open fun getBackgroundPattern(): PropertyValue
Get the BackgroundPattern property
Return
property wrapper value around String
setBackgroundColorTransition
open fun setBackgroundColorTransition(options: TransitionOptions)
Set the BackgroundColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setBackgroundOpacityTransition
open fun setBackgroundOpacityTransition(options: TransitionOptions)
Set the BackgroundOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setBackgroundPatternTransition
open fun setBackgroundPatternTransition(options: TransitionOptions)
Set the BackgroundPattern property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
CannotAddLayerException
open class CannotAddLayerException : RuntimeException
Thrown when adding a layer to a map twice
Constructors
Name | Summary |
---|---|
CannotAddLayerException | open fun CannotAddLayerException(message: String) |
Functions
Name | Summary |
---|---|
addSuppressed | fun addSuppressed(exception: Throwable) |
fillInStackTrace | open fun fillInStackTrace(): Throwable |
getCause | open fun getCause(): Throwable |
getLocalizedMessage | open fun getLocalizedMessage(): String |
getMessage | open fun getMessage(): String |
getStackTrace | open fun getStackTrace(): Array |
getSuppressed | fun getSuppressed(): Array |
initCause | open fun initCause(cause: Throwable): Throwable |
printStackTrace | open fun printStackTrace() |
setStackTrace | open fun setStackTrace(stackTrace: Array |
toString | open fun toString(): String |
CircleLayer
@UiThread()
open class CircleLayer : Layer
A filled circle.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
CircleLayer | open fun CircleLayer(nativePtr: Long)Creates a CircleLayer. |
CircleLayer | open fun CircleLayer(layerId: String, sourceId: String)Creates a CircleLayer. |
Functions
Name | Summary |
---|---|
getCircleBlur | @NonNull() open fun getCircleBlur(): PropertyValue Get the CircleBlur property |
getCircleBlurTransition | @NonNull() open fun getCircleBlurTransition(): TransitionOptions Get the CircleBlur property transition options |
getCircleColor | @NonNull() open fun getCircleColor(): PropertyValue Get the CircleColor property |
getCircleColorAsInt | open fun getCircleColorAsInt(): Int The fill color of the circle. |
getCircleColorTransition | @NonNull() open fun getCircleColorTransition(): TransitionOptions Get the CircleColor property transition options |
getCircleOpacity | @NonNull() open fun getCircleOpacity(): PropertyValue Get the CircleOpacity property |
getCircleOpacityTransition | @NonNull() open fun getCircleOpacityTransition(): TransitionOptions Get the CircleOpacity property transition options |
getCirclePitchAlignment | @NonNull() open fun getCirclePitchAlignment(): PropertyValue Get the CirclePitchAlignment property |
getCirclePitchScale | @NonNull() open fun getCirclePitchScale(): PropertyValue Get the CirclePitchScale property |
getCircleRadius | @NonNull() open fun getCircleRadius(): PropertyValue Get the CircleRadius property |
getCircleRadiusTransition | @NonNull() open fun getCircleRadiusTransition(): TransitionOptions Get the CircleRadius property transition options |
getCircleSortKey | @NonNull() open fun getCircleSortKey(): PropertyValue Get the CircleSortKey property |
getCircleStrokeColor | @NonNull() open fun getCircleStrokeColor(): PropertyValue Get the CircleStrokeColor property |
getCircleStrokeColorAsInt | open fun getCircleStrokeColorAsInt(): Int The stroke color of the circle. |
getCircleStrokeColorTransition | @NonNull() open fun getCircleStrokeColorTransition(): TransitionOptions Get the CircleStrokeColor property transition options |
getCircleStrokeOpacity | @NonNull() open fun getCircleStrokeOpacity(): PropertyValue Get the CircleStrokeOpacity property |
getCircleStrokeOpacityTransition | @NonNull() open fun getCircleStrokeOpacityTransition(): TransitionOptions Get the CircleStrokeOpacity property transition options |
getCircleStrokeWidth | @NonNull() open fun getCircleStrokeWidth(): PropertyValue Get the CircleStrokeWidth property |
getCircleStrokeWidthTransition | @NonNull() open fun getCircleStrokeWidthTransition(): TransitionOptions Get the CircleStrokeWidth property transition options |
getCircleTranslate | @NonNull() open fun getCircleTranslate(): PropertyValue<Array Get the CircleTranslate property |
getCircleTranslateAnchor | @NonNull() open fun getCircleTranslateAnchor(): PropertyValue Get the CircleTranslateAnchor property |
getCircleTranslateTransition | @NonNull() open fun getCircleTranslateTransition(): TransitionOptions Get the CircleTranslate property transition options |
getFilter | @Nullable() open fun getFilter(): Expression Get a single expression filter. |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getSourceLayer | @NonNull() open fun getSourceLayer(): String Get the source layer. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setCircleBlurTransition | open fun setCircleBlurTransition(options: TransitionOptions) Set the CircleBlur property transition options |
setCircleColorTransition | open fun setCircleColorTransition(options: TransitionOptions) Set the CircleColor property transition options |
setCircleOpacityTransition | open fun setCircleOpacityTransition(options: TransitionOptions) Set the CircleOpacity property transition options |
setCircleRadiusTransition | open fun setCircleRadiusTransition(options: TransitionOptions) Set the CircleRadius property transition options |
setCircleStrokeColorTransition | open fun setCircleStrokeColorTransition(options: TransitionOptions) Set the CircleStrokeColor property transition options |
setCircleStrokeOpacityTransition | open fun setCircleStrokeOpacityTransition(options: TransitionOptions) Set the CircleStrokeOpacity property transition options |
setCircleStrokeWidthTransition | open fun setCircleStrokeWidthTransition(options: TransitionOptions) Set the CircleStrokeWidth property transition options |
setCircleTranslateTransition | open fun setCircleTranslateTransition(options: TransitionOptions) Set the CircleTranslate property transition options |
setDetached | open fun setDetached() |
setFilter | open fun setFilter(filter: Expression) Set a single expression filter. |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withFilter | @NonNull() open fun withFilter(filter: Expression): CircleLayer Set a single expression filter. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): CircleLayer Set the source Layer. |
getCircleBlurTransition
@NonNull()
open fun getCircleBlurTransition(): TransitionOptions
Get the CircleBlur property transition options
Return
transition options for Float
getCircleBlur
@NonNull()
open fun getCircleBlur(): PropertyValue
Get the CircleBlur property
Return
property wrapper value around Float
getCircleColorAsInt
open fun getCircleColorAsInt(): Int
The fill color of the circle.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getCircleColorTransition
@NonNull()
open fun getCircleColorTransition(): TransitionOptions
Get the CircleColor property transition options
Return
transition options for String
getCircleColor
@NonNull()
open fun getCircleColor(): PropertyValue
Get the CircleColor property
Return
property wrapper value around String
getCircleOpacityTransition
@NonNull()
open fun getCircleOpacityTransition(): TransitionOptions
Get the CircleOpacity property transition options
Return
transition options for Float
getCircleOpacity
@NonNull()
open fun getCircleOpacity(): PropertyValue
Get the CircleOpacity property
Return
property wrapper value around Float
getCirclePitchAlignment
@NonNull()
open fun getCirclePitchAlignment(): PropertyValue
Get the CirclePitchAlignment property
Return
property wrapper value around String
getCirclePitchScale
@NonNull()
open fun getCirclePitchScale(): PropertyValue
Get the CirclePitchScale property
Return
property wrapper value around String
getCircleRadiusTransition
@NonNull()
open fun getCircleRadiusTransition(): TransitionOptions
Get the CircleRadius property transition options
Return
transition options for Float
getCircleRadius
@NonNull()
open fun getCircleRadius(): PropertyValue
Get the CircleRadius property
Return
property wrapper value around Float
getCircleSortKey
@NonNull()
open fun getCircleSortKey(): PropertyValue
Get the CircleSortKey property
Return
property wrapper value around Float
getCircleStrokeColorAsInt
open fun getCircleStrokeColorAsInt(): Int
The stroke color of the circle.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getCircleStrokeColorTransition
@NonNull()
open fun getCircleStrokeColorTransition(): TransitionOptions
Get the CircleStrokeColor property transition options
Return
transition options for String
getCircleStrokeColor
@NonNull()
open fun getCircleStrokeColor(): PropertyValue
Get the CircleStrokeColor property
Return
property wrapper value around String
getCircleStrokeOpacityTransition
@NonNull()
open fun getCircleStrokeOpacityTransition(): TransitionOptions
Get the CircleStrokeOpacity property transition options
Return
transition options for Float
getCircleStrokeOpacity
@NonNull()
open fun getCircleStrokeOpacity(): PropertyValue
Get the CircleStrokeOpacity property
Return
property wrapper value around Float
getCircleStrokeWidthTransition
@NonNull()
open fun getCircleStrokeWidthTransition(): TransitionOptions
Get the CircleStrokeWidth property transition options
Return
transition options for Float
getCircleStrokeWidth
@NonNull()
open fun getCircleStrokeWidth(): PropertyValue
Get the CircleStrokeWidth property
Return
property wrapper value around Float
getCircleTranslateAnchor
@NonNull()
open fun getCircleTranslateAnchor(): PropertyValue
Get the CircleTranslateAnchor property
Return
property wrapper value around String
getCircleTranslateTransition
@NonNull()
open fun getCircleTranslateTransition(): TransitionOptions
Get the CircleTranslate property transition options
Return
transition options for Float[]
getCircleTranslate
@NonNull()
open fun getCircleTranslate(): PropertyValue<Array
Get the CircleTranslate property
Return
property wrapper value around Float[]
getFilter
@Nullable()
open fun getFilter(): Expression
Get a single expression filter.
Return
the expression filter to get
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
getSourceLayer
@NonNull()
open fun getSourceLayer(): String
Get the source layer.
Return
sourceLayer the source layer to get
setCircleBlurTransition
open fun setCircleBlurTransition(options: TransitionOptions)
Set the CircleBlur property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setCircleColorTransition
open fun setCircleColorTransition(options: TransitionOptions)
Set the CircleColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setCircleOpacityTransition
open fun setCircleOpacityTransition(options: TransitionOptions)
Set the CircleOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setCircleRadiusTransition
open fun setCircleRadiusTransition(options: TransitionOptions)
Set the CircleRadius property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setCircleStrokeColorTransition
open fun setCircleStrokeColorTransition(options: TransitionOptions)
Set the CircleStrokeColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setCircleStrokeOpacityTransition
open fun setCircleStrokeOpacityTransition(options: TransitionOptions)
Set the CircleStrokeOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setCircleStrokeWidthTransition
open fun setCircleStrokeWidthTransition(options: TransitionOptions)
Set the CircleStrokeWidth property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setCircleTranslateTransition
open fun setCircleTranslateTransition(options: TransitionOptions)
Set the CircleTranslate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
setFilter
open fun setFilter(filter: Expression)
Set a single expression filter.
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withFilter
@NonNull()
open fun withFilter(filter: Expression): CircleLayer
Set a single expression filter.
Return
This
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): CircleLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
CustomLayer
open class CustomLayer : Layer
Custom layer.
Experimental feature. Do not use.
Constructors
Name | Summary |
---|---|
CustomLayer | open fun CustomLayer(id: String, host: Long) |
CustomLayer | open fun CustomLayer(nativePtr: Long) |
Functions
Name | Summary |
---|---|
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
FillExtrusionLayer
@UiThread()
open class FillExtrusionLayer : Layer
An extruded (3D) polygon.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
FillExtrusionLayer | open fun FillExtrusionLayer(nativePtr: Long)Creates a FillExtrusionLayer. |
FillExtrusionLayer | open fun FillExtrusionLayer(layerId: String, sourceId: String)Creates a FillExtrusionLayer. |
Functions
Name | Summary |
---|---|
getFillExtrusionBase | @NonNull() open fun getFillExtrusionBase(): PropertyValue Get the FillExtrusionBase property |
getFillExtrusionBaseTransition | @NonNull() open fun getFillExtrusionBaseTransition(): TransitionOptions Get the FillExtrusionBase property transition options |
getFillExtrusionColor | @NonNull() open fun getFillExtrusionColor(): PropertyValue Get the FillExtrusionColor property |
getFillExtrusionColorAsInt | open fun getFillExtrusionColorAsInt(): Int The base color of the extruded fill. |
getFillExtrusionColorTransition | @NonNull() open fun getFillExtrusionColorTransition(): TransitionOptions Get the FillExtrusionColor property transition options |
getFillExtrusionHeight | @NonNull() open fun getFillExtrusionHeight(): PropertyValue Get the FillExtrusionHeight property |
getFillExtrusionHeightTransition | @NonNull() open fun getFillExtrusionHeightTransition(): TransitionOptions Get the FillExtrusionHeight property transition options |
getFillExtrusionOpacity | @NonNull() open fun getFillExtrusionOpacity(): PropertyValue Get the FillExtrusionOpacity property |
getFillExtrusionOpacityTransition | @NonNull() open fun getFillExtrusionOpacityTransition(): TransitionOptions Get the FillExtrusionOpacity property transition options |
getFillExtrusionPattern | @NonNull() open fun getFillExtrusionPattern(): PropertyValue Get the FillExtrusionPattern property |
getFillExtrusionPatternTransition | @NonNull() open fun getFillExtrusionPatternTransition(): TransitionOptions Get the FillExtrusionPattern property transition options |
getFillExtrusionTranslate | @NonNull() open fun getFillExtrusionTranslate(): PropertyValue<Array Get the FillExtrusionTranslate property |
getFillExtrusionTranslateAnchor | @NonNull() open fun getFillExtrusionTranslateAnchor(): PropertyValue Get the FillExtrusionTranslateAnchor property |
getFillExtrusionTranslateTransition | @NonNull() open fun getFillExtrusionTranslateTransition(): TransitionOptions Get the FillExtrusionTranslate property transition options |
getFillExtrusionVerticalGradient | @NonNull() open fun getFillExtrusionVerticalGradient(): PropertyValue Get the FillExtrusionVerticalGradient property |
getFilter | @Nullable() open fun getFilter(): Expression Get a single expression filter. |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getSourceLayer | @NonNull() open fun getSourceLayer(): String Get the source layer. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setFillExtrusionBaseTransition | open fun setFillExtrusionBaseTransition(options: TransitionOptions) Set the FillExtrusionBase property transition options |
setFillExtrusionColorTransition | open fun setFillExtrusionColorTransition(options: TransitionOptions) Set the FillExtrusionColor property transition options |
setFillExtrusionHeightTransition | open fun setFillExtrusionHeightTransition(options: TransitionOptions) Set the FillExtrusionHeight property transition options |
setFillExtrusionOpacityTransition | open fun setFillExtrusionOpacityTransition(options: TransitionOptions) Set the FillExtrusionOpacity property transition options |
setFillExtrusionPatternTransition | open fun setFillExtrusionPatternTransition(options: TransitionOptions) Set the FillExtrusionPattern property transition options |
setFillExtrusionTranslateTransition | open fun setFillExtrusionTranslateTransition(options: TransitionOptions) Set the FillExtrusionTranslate property transition options |
setFilter | open fun setFilter(filter: Expression) Set a single expression filter. |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withFilter | @NonNull() open fun withFilter(filter: Expression): FillExtrusionLayer Set a single expression filter. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): FillExtrusionLayer Set the source Layer. |
getFillExtrusionBaseTransition
@NonNull()
open fun getFillExtrusionBaseTransition(): TransitionOptions
Get the FillExtrusionBase property transition options
Return
transition options for Float
getFillExtrusionBase
@NonNull()
open fun getFillExtrusionBase(): PropertyValue
Get the FillExtrusionBase property
Return
property wrapper value around Float
getFillExtrusionColorAsInt
open fun getFillExtrusionColorAsInt(): Int
The base color of the extruded fill. The extrusion’s surfaces will be shaded differently based on this color in combination with the root light
settings. If this color is specified as rgba
with an alpha component, the alpha component will be ignored; use fill-extrusion-opacity
to set layer opacity.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getFillExtrusionColorTransition
@NonNull()
open fun getFillExtrusionColorTransition(): TransitionOptions
Get the FillExtrusionColor property transition options
Return
transition options for String
getFillExtrusionColor
@NonNull()
open fun getFillExtrusionColor(): PropertyValue
Get the FillExtrusionColor property
Return
property wrapper value around String
getFillExtrusionHeightTransition
@NonNull()
open fun getFillExtrusionHeightTransition(): TransitionOptions
Get the FillExtrusionHeight property transition options
Return
transition options for Float
getFillExtrusionHeight
@NonNull()
open fun getFillExtrusionHeight(): PropertyValue
Get the FillExtrusionHeight property
Return
property wrapper value around Float
getFillExtrusionOpacityTransition
@NonNull()
open fun getFillExtrusionOpacityTransition(): TransitionOptions
Get the FillExtrusionOpacity property transition options
Return
transition options for Float
getFillExtrusionOpacity
@NonNull()
open fun getFillExtrusionOpacity(): PropertyValue
Get the FillExtrusionOpacity property
Return
property wrapper value around Float
getFillExtrusionPatternTransition
@NonNull()
open fun getFillExtrusionPatternTransition(): TransitionOptions
Get the FillExtrusionPattern property transition options
Return
transition options for String
getFillExtrusionPattern
@NonNull()
open fun getFillExtrusionPattern(): PropertyValue
Get the FillExtrusionPattern property
Return
property wrapper value around String
getFillExtrusionTranslateAnchor
@NonNull()
open fun getFillExtrusionTranslateAnchor(): PropertyValue
Get the FillExtrusionTranslateAnchor property
Return
property wrapper value around String
getFillExtrusionTranslateTransition
@NonNull()
open fun getFillExtrusionTranslateTransition(): TransitionOptions
Get the FillExtrusionTranslate property transition options
Return
transition options for Float[]
getFillExtrusionTranslate
@NonNull()
open fun getFillExtrusionTranslate(): PropertyValue<Array
Get the FillExtrusionTranslate property
Return
property wrapper value around Float[]
getFillExtrusionVerticalGradient
@NonNull()
open fun getFillExtrusionVerticalGradient(): PropertyValue
Get the FillExtrusionVerticalGradient property
Return
property wrapper value around Boolean
getFilter
@Nullable()
open fun getFilter(): Expression
Get a single expression filter.
Return
the expression filter to get
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
getSourceLayer
@NonNull()
open fun getSourceLayer(): String
Get the source layer.
Return
sourceLayer the source layer to get
setFillExtrusionBaseTransition
open fun setFillExtrusionBaseTransition(options: TransitionOptions)
Set the FillExtrusionBase property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setFillExtrusionColorTransition
open fun setFillExtrusionColorTransition(options: TransitionOptions)
Set the FillExtrusionColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setFillExtrusionHeightTransition
open fun setFillExtrusionHeightTransition(options: TransitionOptions)
Set the FillExtrusionHeight property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setFillExtrusionOpacityTransition
open fun setFillExtrusionOpacityTransition(options: TransitionOptions)
Set the FillExtrusionOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setFillExtrusionPatternTransition
open fun setFillExtrusionPatternTransition(options: TransitionOptions)
Set the FillExtrusionPattern property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setFillExtrusionTranslateTransition
open fun setFillExtrusionTranslateTransition(options: TransitionOptions)
Set the FillExtrusionTranslate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
setFilter
open fun setFilter(filter: Expression)
Set a single expression filter.
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withFilter
@NonNull()
open fun withFilter(filter: Expression): FillExtrusionLayer
Set a single expression filter.
Return
This
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): FillExtrusionLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
FillLayer
@UiThread()
A filled polygon with an optional stroked border.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
FillLayer | open fun FillLayer(nativePtr: Long)Creates a FillLayer. |
FillLayer | open fun FillLayer(layerId: String, sourceId: String)Creates a FillLayer. |
Functions
Name | Summary |
---|---|
getFillAntialias | @NonNull() open fun getFillAntialias(): PropertyValue Get the FillAntialias property |
getFillColor | @NonNull() open fun getFillColor(): PropertyValue Get the FillColor property |
getFillColorAsInt | open fun getFillColorAsInt(): Int The color of the filled part of this layer. |
getFillColorTransition | @NonNull() open fun getFillColorTransition(): TransitionOptions Get the FillColor property transition options |
getFillOpacity | @NonNull() open fun getFillOpacity(): PropertyValue Get the FillOpacity property |
getFillOpacityTransition | @NonNull() open fun getFillOpacityTransition(): TransitionOptions Get the FillOpacity property transition options |
getFillOutlineColor | @NonNull() open fun getFillOutlineColor(): PropertyValue Get the FillOutlineColor property |
getFillOutlineColorAsInt | open fun getFillOutlineColorAsInt(): Int The outline color of the fill. |
getFillOutlineColorTransition | @NonNull() open fun getFillOutlineColorTransition(): TransitionOptions Get the FillOutlineColor property transition options |
getFillPattern | @NonNull() open fun getFillPattern(): PropertyValue Get the FillPattern property |
getFillPatternTransition | @NonNull() open fun getFillPatternTransition(): TransitionOptions Get the FillPattern property transition options |
getFillSortKey | @NonNull() open fun getFillSortKey(): PropertyValue Get the FillSortKey property |
getFillTranslate | @NonNull() open fun getFillTranslate(): PropertyValue<Array Get the FillTranslate property |
getFillTranslateAnchor | @NonNull() open fun getFillTranslateAnchor(): PropertyValue Get the FillTranslateAnchor property |
getFillTranslateTransition | @NonNull() open fun getFillTranslateTransition(): TransitionOptions Get the FillTranslate property transition options |
getFilter | @Nullable() open fun getFilter(): Expression Get a single expression filter. |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getSourceLayer | @NonNull() open fun getSourceLayer(): String Get the source layer. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setFillColorTransition | open fun setFillColorTransition(options: TransitionOptions) Set the FillColor property transition options |
setFillOpacityTransition | open fun setFillOpacityTransition(options: TransitionOptions) Set the FillOpacity property transition options |
setFillOutlineColorTransition | open fun setFillOutlineColorTransition(options: TransitionOptions) Set the FillOutlineColor property transition options |
setFillPatternTransition | open fun setFillPatternTransition(options: TransitionOptions) Set the FillPattern property transition options |
setFillTranslateTransition | open fun setFillTranslateTransition(options: TransitionOptions) Set the FillTranslate property transition options |
setFilter | open fun setFilter(filter: Expression) Set a single expression filter. |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withFilter | @NonNull() open fun withFilter(filter: Expression): FillLayer Set a single expression filter. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): FillLayer Set the source Layer. |
getFillAntialias
@NonNull()
open fun getFillAntialias(): PropertyValue
Get the FillAntialias property
Return
property wrapper value around Boolean
getFillColorAsInt
open fun getFillColorAsInt(): Int
The color of the filled part of this layer. This color can be specified as rgba
with an alpha component and the color’s opacity will not affect the opacity of the 1px stroke, if it is used.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getFillColorTransition
@NonNull()
open fun getFillColorTransition(): TransitionOptions
Get the FillColor property transition options
Return
transition options for String
getFillColor
@NonNull()
open fun getFillColor(): PropertyValue
Get the FillColor property
Return
property wrapper value around String
getFillOpacityTransition
@NonNull()
open fun getFillOpacityTransition(): TransitionOptions
Get the FillOpacity property transition options
Return
transition options for Float
getFillOpacity
@NonNull()
open fun getFillOpacity(): PropertyValue
Get the FillOpacity property
Return
property wrapper value around Float
getFillOutlineColorAsInt
open fun getFillOutlineColorAsInt(): Int
The outline color of the fill. Matches the value of fill-color
if unspecified.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getFillOutlineColorTransition
@NonNull()
open fun getFillOutlineColorTransition(): TransitionOptions
Get the FillOutlineColor property transition options
Return
transition options for String
getFillOutlineColor
@NonNull()
open fun getFillOutlineColor(): PropertyValue
Get the FillOutlineColor property
Return
property wrapper value around String
getFillPatternTransition
@NonNull()
open fun getFillPatternTransition(): TransitionOptions
Get the FillPattern property transition options
Return
transition options for String
getFillPattern
@NonNull()
open fun getFillPattern(): PropertyValue
Get the FillPattern property
Return
property wrapper value around String
getFillSortKey
@NonNull()
open fun getFillSortKey(): PropertyValue
Get the FillSortKey property
Return
property wrapper value around Float
getFillTranslateAnchor
@NonNull()
open fun getFillTranslateAnchor(): PropertyValue
Get the FillTranslateAnchor property
Return
property wrapper value around String
getFillTranslateTransition
@NonNull()
open fun getFillTranslateTransition(): TransitionOptions
Get the FillTranslate property transition options
Return
transition options for Float[]
getFillTranslate
@NonNull()
open fun getFillTranslate(): PropertyValue<Array
Get the FillTranslate property
Return
property wrapper value around Float[]
getFilter
@Nullable()
open fun getFilter(): Expression
Get a single expression filter.
Return
the expression filter to get
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
getSourceLayer
@NonNull()
open fun getSourceLayer(): String
Get the source layer.
Return
sourceLayer the source layer to get
setFillColorTransition
open fun setFillColorTransition(options: TransitionOptions)
Set the FillColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setFillOpacityTransition
open fun setFillOpacityTransition(options: TransitionOptions)
Set the FillOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setFillOutlineColorTransition
open fun setFillOutlineColorTransition(options: TransitionOptions)
Set the FillOutlineColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setFillPatternTransition
open fun setFillPatternTransition(options: TransitionOptions)
Set the FillPattern property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setFillTranslateTransition
open fun setFillTranslateTransition(options: TransitionOptions)
Set the FillTranslate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
setFilter
open fun setFilter(filter: Expression)
Set a single expression filter.
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withFilter
@NonNull()
open fun withFilter(filter: Expression): FillLayer
Set a single expression filter.
Return
This
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): FillLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
HeatmapLayer
@UiThread()
open class HeatmapLayer : Layer
A heatmap.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
HeatmapLayer | open fun HeatmapLayer(nativePtr: Long)Creates a HeatmapLayer. |
HeatmapLayer | open fun HeatmapLayer(layerId: String, sourceId: String)Creates a HeatmapLayer. |
Functions
Name | Summary |
---|---|
getFilter | @Nullable() open fun getFilter(): Expression Get a single expression filter. |
getHeatmapColor | @NonNull() open fun getHeatmapColor(): PropertyValue Get the HeatmapColor property |
getHeatmapColorAsInt | open fun getHeatmapColorAsInt(): Int Defines the color of each pixel based on its density value in a heatmap. |
getHeatmapIntensity | @NonNull() open fun getHeatmapIntensity(): PropertyValue Get the HeatmapIntensity property |
getHeatmapIntensityTransition | @NonNull() open fun getHeatmapIntensityTransition(): TransitionOptions Get the HeatmapIntensity property transition options |
getHeatmapOpacity | @NonNull() open fun getHeatmapOpacity(): PropertyValue Get the HeatmapOpacity property |
getHeatmapOpacityTransition | @NonNull() open fun getHeatmapOpacityTransition(): TransitionOptions Get the HeatmapOpacity property transition options |
getHeatmapRadius | @NonNull() open fun getHeatmapRadius(): PropertyValue Get the HeatmapRadius property |
getHeatmapRadiusTransition | @NonNull() open fun getHeatmapRadiusTransition(): TransitionOptions Get the HeatmapRadius property transition options |
getHeatmapWeight | @NonNull() open fun getHeatmapWeight(): PropertyValue Get the HeatmapWeight property |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getSourceLayer | @NonNull() open fun getSourceLayer(): String Get the source layer. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setFilter | open fun setFilter(filter: Expression) Set a single expression filter. |
setHeatmapIntensityTransition | open fun setHeatmapIntensityTransition(options: TransitionOptions) Set the HeatmapIntensity property transition options |
setHeatmapOpacityTransition | open fun setHeatmapOpacityTransition(options: TransitionOptions) Set the HeatmapOpacity property transition options |
setHeatmapRadiusTransition | open fun setHeatmapRadiusTransition(options: TransitionOptions) Set the HeatmapRadius property transition options |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withFilter | @NonNull() open fun withFilter(filter: Expression): HeatmapLayer Set a single expression filter. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): HeatmapLayer Set the source Layer. |
getFilter
@Nullable()
open fun getFilter(): Expression
Get a single expression filter.
Return
the expression filter to get
getHeatmapColorAsInt
open fun getHeatmapColorAsInt(): Int
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"]
as input.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getHeatmapColor
@NonNull()
open fun getHeatmapColor(): PropertyValue
Get the HeatmapColor property
Return
property wrapper value around String
getHeatmapIntensityTransition
@NonNull()
open fun getHeatmapIntensityTransition(): TransitionOptions
Get the HeatmapIntensity property transition options
Return
transition options for Float
getHeatmapIntensity
@NonNull()
open fun getHeatmapIntensity(): PropertyValue
Get the HeatmapIntensity property
Return
property wrapper value around Float
getHeatmapOpacityTransition
@NonNull()
open fun getHeatmapOpacityTransition(): TransitionOptions
Get the HeatmapOpacity property transition options
Return
transition options for Float
getHeatmapOpacity
@NonNull()
open fun getHeatmapOpacity(): PropertyValue
Get the HeatmapOpacity property
Return
property wrapper value around Float
getHeatmapRadiusTransition
@NonNull()
open fun getHeatmapRadiusTransition(): TransitionOptions
Get the HeatmapRadius property transition options
Return
transition options for Float
getHeatmapRadius
@NonNull()
open fun getHeatmapRadius(): PropertyValue
Get the HeatmapRadius property
Return
property wrapper value around Float
getHeatmapWeight
@NonNull()
open fun getHeatmapWeight(): PropertyValue
Get the HeatmapWeight property
Return
property wrapper value around Float
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
getSourceLayer
@NonNull()
open fun getSourceLayer(): String
Get the source layer.
Return
sourceLayer the source layer to get
setFilter
open fun setFilter(filter: Expression)
Set a single expression filter.
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
setHeatmapIntensityTransition
open fun setHeatmapIntensityTransition(options: TransitionOptions)
Set the HeatmapIntensity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setHeatmapOpacityTransition
open fun setHeatmapOpacityTransition(options: TransitionOptions)
Set the HeatmapOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setHeatmapRadiusTransition
open fun setHeatmapRadiusTransition(options: TransitionOptions)
Set the HeatmapRadius property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withFilter
@NonNull()
open fun withFilter(filter: Expression): HeatmapLayer
Set a single expression filter.
Return
This
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): HeatmapLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
HillshadeLayer
@UiThread()
open class HillshadeLayer : Layer
Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
HillshadeLayer | open fun HillshadeLayer(nativePtr: Long)Creates a HillshadeLayer. |
HillshadeLayer | open fun HillshadeLayer(layerId: String, sourceId: String)Creates a HillshadeLayer. |
Functions
Name | Summary |
---|---|
getHillshadeAccentColor | @NonNull() open fun getHillshadeAccentColor(): PropertyValue Get the HillshadeAccentColor property |
getHillshadeAccentColorAsInt | open fun getHillshadeAccentColorAsInt(): Int The shading color used to accentuate rugged terrain like sharp cliffs and gorges. |
getHillshadeAccentColorTransition | @NonNull() open fun getHillshadeAccentColorTransition(): TransitionOptions Get the HillshadeAccentColor property transition options |
getHillshadeExaggeration | @NonNull() open fun getHillshadeExaggeration(): PropertyValue Get the HillshadeExaggeration property |
getHillshadeExaggerationTransition | @NonNull() open fun getHillshadeExaggerationTransition(): TransitionOptions Get the HillshadeExaggeration property transition options |
getHillshadeHighlightColor | @NonNull() open fun getHillshadeHighlightColor(): PropertyValue Get the HillshadeHighlightColor property |
getHillshadeHighlightColorAsInt | open fun getHillshadeHighlightColorAsInt(): Int The shading color of areas that faces towards the light source. |
getHillshadeHighlightColorTransition | @NonNull() open fun getHillshadeHighlightColorTransition(): TransitionOptions Get the HillshadeHighlightColor property transition options |
getHillshadeIlluminationAnchor | @NonNull() open fun getHillshadeIlluminationAnchor(): PropertyValue Get the HillshadeIlluminationAnchor property |
getHillshadeIlluminationDirection | @NonNull() open fun getHillshadeIlluminationDirection(): PropertyValue Get the HillshadeIlluminationDirection property |
getHillshadeShadowColor | @NonNull() open fun getHillshadeShadowColor(): PropertyValue Get the HillshadeShadowColor property |
getHillshadeShadowColorAsInt | open fun getHillshadeShadowColorAsInt(): Int The shading color of areas that face away from the light source. |
getHillshadeShadowColorTransition | @NonNull() open fun getHillshadeShadowColorTransition(): TransitionOptions Get the HillshadeShadowColor property transition options |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setHillshadeAccentColorTransition | open fun setHillshadeAccentColorTransition(options: TransitionOptions) Set the HillshadeAccentColor property transition options |
setHillshadeExaggerationTransition | open fun setHillshadeExaggerationTransition(options: TransitionOptions) Set the HillshadeExaggeration property transition options |
setHillshadeHighlightColorTransition | open fun setHillshadeHighlightColorTransition(options: TransitionOptions) Set the HillshadeHighlightColor property transition options |
setHillshadeShadowColorTransition | open fun setHillshadeShadowColorTransition(options: TransitionOptions) Set the HillshadeShadowColor property transition options |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): HillshadeLayer Set the source Layer. |
getHillshadeAccentColorAsInt
open fun getHillshadeAccentColorAsInt(): Int
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getHillshadeAccentColorTransition
@NonNull()
open fun getHillshadeAccentColorTransition(): TransitionOptions
Get the HillshadeAccentColor property transition options
Return
transition options for String
getHillshadeAccentColor
@NonNull()
open fun getHillshadeAccentColor(): PropertyValue
Get the HillshadeAccentColor property
Return
property wrapper value around String
getHillshadeExaggerationTransition
@NonNull()
open fun getHillshadeExaggerationTransition(): TransitionOptions
Get the HillshadeExaggeration property transition options
Return
transition options for Float
getHillshadeExaggeration
@NonNull()
open fun getHillshadeExaggeration(): PropertyValue
Get the HillshadeExaggeration property
Return
property wrapper value around Float
getHillshadeHighlightColorAsInt
open fun getHillshadeHighlightColorAsInt(): Int
The shading color of areas that faces towards the light source.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getHillshadeHighlightColorTransition
@NonNull()
open fun getHillshadeHighlightColorTransition(): TransitionOptions
Get the HillshadeHighlightColor property transition options
Return
transition options for String
getHillshadeHighlightColor
@NonNull()
open fun getHillshadeHighlightColor(): PropertyValue
Get the HillshadeHighlightColor property
Return
property wrapper value around String
getHillshadeIlluminationAnchor
@NonNull()
open fun getHillshadeIlluminationAnchor(): PropertyValue
Get the HillshadeIlluminationAnchor property
Return
property wrapper value around String
getHillshadeIlluminationDirection
@NonNull()
open fun getHillshadeIlluminationDirection(): PropertyValue
Get the HillshadeIlluminationDirection property
Return
property wrapper value around Float
getHillshadeShadowColorAsInt
open fun getHillshadeShadowColorAsInt(): Int
The shading color of areas that face away from the light source.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getHillshadeShadowColorTransition
@NonNull()
open fun getHillshadeShadowColorTransition(): TransitionOptions
Get the HillshadeShadowColor property transition options
Return
transition options for String
getHillshadeShadowColor
@NonNull()
open fun getHillshadeShadowColor(): PropertyValue
Get the HillshadeShadowColor property
Return
property wrapper value around String
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
setHillshadeAccentColorTransition
open fun setHillshadeAccentColorTransition(options: TransitionOptions)
Set the HillshadeAccentColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setHillshadeExaggerationTransition
open fun setHillshadeExaggerationTransition(options: TransitionOptions)
Set the HillshadeExaggeration property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setHillshadeHighlightColorTransition
open fun setHillshadeHighlightColorTransition(options: TransitionOptions)
Set the HillshadeHighlightColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setHillshadeShadowColorTransition
open fun setHillshadeShadowColorTransition(options: TransitionOptions)
Set the HillshadeShadowColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): HillshadeLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
Layer
abstract class Layer
Base class for the different Layer types
Constructors
Name | Summary |
---|---|
Layer | open fun Layer() |
Functions
Name | Summary |
---|---|
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
Properties
Name | Summary |
---|---|
nativePtr | private open val nativePtr: Long |
Inheritors
Name |
---|
LocationIndicatorLayer |
BackgroundLayer |
CircleLayer |
CustomLayer |
FillExtrusionLayer |
FillLayer |
HeatmapLayer |
HillshadeLayer |
LineLayer |
RasterLayer |
SymbolLayer |
getId
@NonNull()
open fun getId(): String
getMaxZoom
open fun getMaxZoom(): Float
getMinZoom
open fun getMinZoom(): Float
getVisibility
@NonNull()
open fun getVisibility(): PropertyValue
isDetached
open fun isDetached(): Boolean
nativePtr
private open val nativePtr: Long
setMaxZoom
open fun setMaxZoom(zoom: Float)
setMinZoom
open fun setMinZoom(zoom: Float)
setProperties
open fun setProperties(properties: Array<PropertyValue
LayoutPropertyValue
open class LayoutPropertyValue<T> : PropertyValue<T>
Constructors
Name | Summary |
---|---|
LayoutPropertyValue | open fun LayoutPropertyValue(name: String, value: T) |
Functions
Name | Summary |
---|---|
equals | open fun equals(o: Any): Boolean |
getColorInt | @Nullable() open fun getColorInt(): Integer Get the color int value of the property if the value is a color. |
getExpression | @Nullable() open fun getExpression(): Expression Get the expression of the property. |
getValue | @Nullable() open fun getValue(): T Get the value of the property. |
hashCode | open fun hashCode(): Int |
isExpression | open fun isExpression(): Boolean Returns if this is a expression. |
isNull | open fun isNull(): Boolean Returns if this is null |
isValue | open fun isValue(): Boolean Returns if this is a value. |
toString | open fun toString(): String Get the string representation of a property value. |
LineLayer
@UiThread()
A stroked line.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
LineLayer | open fun LineLayer(nativePtr: Long)Creates a LineLayer. |
LineLayer | open fun LineLayer(layerId: String, sourceId: String)Creates a LineLayer. |
Functions
Name | Summary |
---|---|
getFilter | @Nullable() open fun getFilter(): Expression Get a single expression filter. |
getId | @NonNull() open fun getId(): String |
getLineBlur | @NonNull() open fun getLineBlur(): PropertyValue Get the LineBlur property |
getLineBlurTransition | @NonNull() open fun getLineBlurTransition(): TransitionOptions Get the LineBlur property transition options |
getLineCap | @NonNull() open fun getLineCap(): PropertyValue Get the LineCap property |
getLineColor | @NonNull() open fun getLineColor(): PropertyValue Get the LineColor property |
getLineColorAsInt | open fun getLineColorAsInt(): Int The color with which the line will be drawn. |
getLineColorTransition | @NonNull() open fun getLineColorTransition(): TransitionOptions Get the LineColor property transition options |
getLineDasharray | @NonNull() open fun getLineDasharray(): PropertyValue<Array Get the LineDasharray property |
getLineDasharrayTransition | @NonNull() open fun getLineDasharrayTransition(): TransitionOptions Get the LineDasharray property transition options |
getLineGapWidth | @NonNull() open fun getLineGapWidth(): PropertyValue Get the LineGapWidth property |
getLineGapWidthTransition | @NonNull() open fun getLineGapWidthTransition(): TransitionOptions Get the LineGapWidth property transition options |
getLineGradient | @NonNull() open fun getLineGradient(): PropertyValue Get the LineGradient property |
getLineGradientAsInt | open fun getLineGradientAsInt(): Int Defines a gradient with which to color a line feature. |
getLineJoin | @NonNull() open fun getLineJoin(): PropertyValue Get the LineJoin property |
getLineMiterLimit | @NonNull() open fun getLineMiterLimit(): PropertyValue Get the LineMiterLimit property |
getLineOffset | @NonNull() open fun getLineOffset(): PropertyValue Get the LineOffset property |
getLineOffsetTransition | @NonNull() open fun getLineOffsetTransition(): TransitionOptions Get the LineOffset property transition options |
getLineOpacity | @NonNull() open fun getLineOpacity(): PropertyValue Get the LineOpacity property |
getLineOpacityTransition | @NonNull() open fun getLineOpacityTransition(): TransitionOptions Get the LineOpacity property transition options |
getLinePattern | @NonNull() open fun getLinePattern(): PropertyValue Get the LinePattern property |
getLinePatternTransition | @NonNull() open fun getLinePatternTransition(): TransitionOptions Get the LinePattern property transition options |
getLineRoundLimit | @NonNull() open fun getLineRoundLimit(): PropertyValue Get the LineRoundLimit property |
getLineSortKey | @NonNull() open fun getLineSortKey(): PropertyValue Get the LineSortKey property |
getLineTranslate | @NonNull() open fun getLineTranslate(): PropertyValue<Array Get the LineTranslate property |
getLineTranslateAnchor | @NonNull() open fun getLineTranslateAnchor(): PropertyValue Get the LineTranslateAnchor property |
getLineTranslateTransition | @NonNull() open fun getLineTranslateTransition(): TransitionOptions Get the LineTranslate property transition options |
getLineWidth | @NonNull() open fun getLineWidth(): PropertyValue Get the LineWidth property |
getLineWidthTransition | @NonNull() open fun getLineWidthTransition(): TransitionOptions Get the LineWidth property transition options |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getSourceLayer | @NonNull() open fun getSourceLayer(): String Get the source layer. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setFilter | open fun setFilter(filter: Expression) Set a single expression filter. |
setLineBlurTransition | open fun setLineBlurTransition(options: TransitionOptions) Set the LineBlur property transition options |
setLineColorTransition | open fun setLineColorTransition(options: TransitionOptions) Set the LineColor property transition options |
setLineDasharrayTransition | open fun setLineDasharrayTransition(options: TransitionOptions) Set the LineDasharray property transition options |
setLineGapWidthTransition | open fun setLineGapWidthTransition(options: TransitionOptions) Set the LineGapWidth property transition options |
setLineOffsetTransition | open fun setLineOffsetTransition(options: TransitionOptions) Set the LineOffset property transition options |
setLineOpacityTransition | open fun setLineOpacityTransition(options: TransitionOptions) Set the LineOpacity property transition options |
setLinePatternTransition | open fun setLinePatternTransition(options: TransitionOptions) Set the LinePattern property transition options |
setLineTranslateTransition | open fun setLineTranslateTransition(options: TransitionOptions) Set the LineTranslate property transition options |
setLineWidthTransition | open fun setLineWidthTransition(options: TransitionOptions) Set the LineWidth property transition options |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withFilter | @NonNull() open fun withFilter(filter: Expression): LineLayer Set a single expression filter. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): LineLayer Set the source Layer. |
getFilter
@Nullable()
open fun getFilter(): Expression
Get a single expression filter.
Return
the expression filter to get
getLineBlurTransition
@NonNull()
open fun getLineBlurTransition(): TransitionOptions
Get the LineBlur property transition options
Return
transition options for Float
getLineBlur
@NonNull()
open fun getLineBlur(): PropertyValue
Get the LineBlur property
Return
property wrapper value around Float
getLineCap
@NonNull()
open fun getLineCap(): PropertyValue
Get the LineCap property
Return
property wrapper value around String
getLineColorAsInt
open fun getLineColorAsInt(): Int
The color with which the line will be drawn.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getLineColorTransition
@NonNull()
open fun getLineColorTransition(): TransitionOptions
Get the LineColor property transition options
Return
transition options for String
getLineColor
@NonNull()
open fun getLineColor(): PropertyValue
Get the LineColor property
Return
property wrapper value around String
getLineDasharrayTransition
@NonNull()
open fun getLineDasharrayTransition(): TransitionOptions
Get the LineDasharray property transition options
Return
transition options for Float[]
getLineDasharray
@NonNull()
open fun getLineDasharray(): PropertyValue<Array
Get the LineDasharray property
Return
property wrapper value around Float[]
getLineGapWidthTransition
@NonNull()
open fun getLineGapWidthTransition(): TransitionOptions
Get the LineGapWidth property transition options
Return
transition options for Float
getLineGapWidth
@NonNull()
open fun getLineGapWidth(): PropertyValue
Get the LineGapWidth property
Return
property wrapper value around Float
getLineGradientAsInt
open fun getLineGradientAsInt(): Int
Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true
.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getLineGradient
@NonNull()
open fun getLineGradient(): PropertyValue
Get the LineGradient property
Return
property wrapper value around String
getLineJoin
@NonNull()
open fun getLineJoin(): PropertyValue
Get the LineJoin property
Return
property wrapper value around String
getLineMiterLimit
@NonNull()
open fun getLineMiterLimit(): PropertyValue
Get the LineMiterLimit property
Return
property wrapper value around Float
getLineOffsetTransition
@NonNull()
open fun getLineOffsetTransition(): TransitionOptions
Get the LineOffset property transition options
Return
transition options for Float
getLineOffset
@NonNull()
open fun getLineOffset(): PropertyValue
Get the LineOffset property
Return
property wrapper value around Float
getLineOpacityTransition
@NonNull()
open fun getLineOpacityTransition(): TransitionOptions
Get the LineOpacity property transition options
Return
transition options for Float
getLineOpacity
@NonNull()
open fun getLineOpacity(): PropertyValue
Get the LineOpacity property
Return
property wrapper value around Float
getLinePatternTransition
@NonNull()
open fun getLinePatternTransition(): TransitionOptions
Get the LinePattern property transition options
Return
transition options for String
getLinePattern
@NonNull()
open fun getLinePattern(): PropertyValue
Get the LinePattern property
Return
property wrapper value around String
getLineRoundLimit
@NonNull()
open fun getLineRoundLimit(): PropertyValue
Get the LineRoundLimit property
Return
property wrapper value around Float
getLineSortKey
@NonNull()
open fun getLineSortKey(): PropertyValue
Get the LineSortKey property
Return
property wrapper value around Float
getLineTranslateAnchor
@NonNull()
open fun getLineTranslateAnchor(): PropertyValue
Get the LineTranslateAnchor property
Return
property wrapper value around String
getLineTranslateTransition
@NonNull()
open fun getLineTranslateTransition(): TransitionOptions
Get the LineTranslate property transition options
Return
transition options for Float[]
getLineTranslate
@NonNull()
open fun getLineTranslate(): PropertyValue<Array
Get the LineTranslate property
Return
property wrapper value around Float[]
getLineWidthTransition
@NonNull()
open fun getLineWidthTransition(): TransitionOptions
Get the LineWidth property transition options
Return
transition options for Float
getLineWidth
@NonNull()
open fun getLineWidth(): PropertyValue
Get the LineWidth property
Return
property wrapper value around Float
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
getSourceLayer
@NonNull()
open fun getSourceLayer(): String
Get the source layer.
Return
sourceLayer the source layer to get
setFilter
open fun setFilter(filter: Expression)
Set a single expression filter.
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
setLineBlurTransition
open fun setLineBlurTransition(options: TransitionOptions)
Set the LineBlur property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setLineColorTransition
open fun setLineColorTransition(options: TransitionOptions)
Set the LineColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setLineDasharrayTransition
open fun setLineDasharrayTransition(options: TransitionOptions)
Set the LineDasharray property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
setLineGapWidthTransition
open fun setLineGapWidthTransition(options: TransitionOptions)
Set the LineGapWidth property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setLineOffsetTransition
open fun setLineOffsetTransition(options: TransitionOptions)
Set the LineOffset property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setLineOpacityTransition
open fun setLineOpacityTransition(options: TransitionOptions)
Set the LineOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setLinePatternTransition
open fun setLinePatternTransition(options: TransitionOptions)
Set the LinePattern property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setLineTranslateTransition
open fun setLineTranslateTransition(options: TransitionOptions)
Set the LineTranslate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
setLineWidthTransition
open fun setLineWidthTransition(options: TransitionOptions)
Set the LineWidth property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withFilter
@NonNull()
open fun withFilter(filter: Expression): LineLayer
Set a single expression filter.
Return
This
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): LineLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
PaintPropertyValue
open class PaintPropertyValue<T> : PropertyValue<T>
Constructors
Name | Summary |
---|---|
PaintPropertyValue | open fun PaintPropertyValue(name: String, value: T) |
Functions
Name | Summary |
---|---|
equals | open fun equals(o: Any): Boolean |
getColorInt | @Nullable() open fun getColorInt(): Integer Get the color int value of the property if the value is a color. |
getExpression | @Nullable() open fun getExpression(): Expression Get the expression of the property. |
getValue | @Nullable() open fun getValue(): T Get the value of the property. |
hashCode | open fun hashCode(): Int |
isExpression | open fun isExpression(): Boolean Returns if this is a expression. |
isNull | open fun isNull(): Boolean Returns if this is null |
isValue | open fun isValue(): Boolean Returns if this is a value. |
toString | open fun toString(): String Get the string representation of a property value. |
Property
class Property
Paint/Layout properties for Layer
Types
Name | Summary |
---|---|
ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class ANCHOR Whether extruded geometries are lit relative to the map or viewport. |
CIRCLE_PITCH_ALIGNMENT | @Retention(value = RetentionPolicy.SOURCE) annotation class CIRCLE_PITCH_ALIGNMENT Orientation of circle when map is pitched. |
CIRCLE_PITCH_SCALE | @Retention(value = RetentionPolicy.SOURCE) annotation class CIRCLE_PITCH_SCALE Controls the scaling behavior of the circle when the map is pitched. |
CIRCLE_TRANSLATE_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class CIRCLE_TRANSLATE_ANCHOR Controls the frame of reference for circle-translate . |
FILL_EXTRUSION_TRANSLATE_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class FILL_EXTRUSION_TRANSLATE_ANCHOR Controls the frame of reference for fill-extrusion-translate . |
FILL_TRANSLATE_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class FILL_TRANSLATE_ANCHOR Controls the frame of reference for fill-translate . |
HILLSHADE_ILLUMINATION_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class HILLSHADE_ILLUMINATION_ANCHOR Direction of light source when map is rotated. |
ICON_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class ICON_ANCHOR Part of the icon placed closest to the anchor. |
ICON_PITCH_ALIGNMENT | @Retention(value = RetentionPolicy.SOURCE) annotation class ICON_PITCH_ALIGNMENT Orientation of icon when map is pitched. |
ICON_ROTATION_ALIGNMENT | @Retention(value = RetentionPolicy.SOURCE) annotation class ICON_ROTATION_ALIGNMENT In combination with symbol-placement , determines the rotation behavior of icons. |
ICON_TEXT_FIT | @Retention(value = RetentionPolicy.SOURCE) annotation class ICON_TEXT_FIT Scales the icon to fit around the associated text. |
ICON_TRANSLATE_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class ICON_TRANSLATE_ANCHOR Controls the frame of reference for icon-translate . |
LINE_CAP | @Retention(value = RetentionPolicy.SOURCE) annotation class LINE_CAP The display of line endings. |
LINE_JOIN | @Retention(value = RetentionPolicy.SOURCE) annotation class LINE_JOIN The display of lines when joining. |
LINE_TRANSLATE_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class LINE_TRANSLATE_ANCHOR Controls the frame of reference for line-translate . |
RASTER_RESAMPLING | @Retention(value = RetentionPolicy.SOURCE) annotation class RASTER_RESAMPLING The resampling/interpolation method to use for overscaling, also known as texture magnification filter |
SYMBOL_PLACEMENT | @Retention(value = RetentionPolicy.SOURCE) annotation class SYMBOL_PLACEMENT Label placement relative to its geometry. |
SYMBOL_Z_ORDER | @Retention(value = RetentionPolicy.SOURCE) annotation class SYMBOL_Z_ORDER Controls the order in which overlapping symbols in the same layer are rendered |
TEXT_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_ANCHOR Part of the text placed closest to the anchor. |
TEXT_JUSTIFY | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_JUSTIFY Text justification options. |
TEXT_PITCH_ALIGNMENT | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_PITCH_ALIGNMENT Orientation of text when map is pitched. |
TEXT_ROTATION_ALIGNMENT | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_ROTATION_ALIGNMENT In combination with symbol-placement , determines the rotation behavior of the individual glyphs forming the text. |
TEXT_TRANSFORM | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_TRANSFORM Specifies how to capitalize text, similar to the CSS text-transform property. |
TEXT_TRANSLATE_ANCHOR | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_TRANSLATE_ANCHOR Controls the frame of reference for text-translate . |
TEXT_WRITING_MODE | @Retention(value = RetentionPolicy.SOURCE) annotation class TEXT_WRITING_MODE The property allows control over a symbol’s orientation. |
VISIBILITY | @Retention(value = RetentionPolicy.SOURCE) annotation class VISIBILITY |
Properties
Name | Summary |
---|---|
ANCHOR_MAP | val ANCHOR_MAP: StringThe position of the light source is aligned to the rotation of the map. |
ANCHOR_VIEWPORT | val ANCHOR_VIEWPORT: StringThe position of the light source is aligned to the rotation of the viewport. |
CIRCLE_PITCH_ALIGNMENT_MAP | val CIRCLE_PITCH_ALIGNMENT_MAP: StringThe circle is aligned to the plane of the map. |
CIRCLE_PITCH_ALIGNMENT_VIEWPORT | val CIRCLE_PITCH_ALIGNMENT_VIEWPORT: StringThe circle is aligned to the plane of the viewport. |
CIRCLE_PITCH_SCALE_MAP | val CIRCLE_PITCH_SCALE_MAP: StringCircles are scaled according to their apparent distance to the camera. |
CIRCLE_PITCH_SCALE_VIEWPORT | val CIRCLE_PITCH_SCALE_VIEWPORT: StringCircles are not scaled. |
CIRCLE_TRANSLATE_ANCHOR_MAP | val CIRCLE_TRANSLATE_ANCHOR_MAP: StringThe circle is translated relative to the map. |
CIRCLE_TRANSLATE_ANCHOR_VIEWPORT | val CIRCLE_TRANSLATE_ANCHOR_VIEWPORT: StringThe circle is translated relative to the viewport. |
FILL_EXTRUSION_TRANSLATE_ANCHOR_MAP | val FILL_EXTRUSION_TRANSLATE_ANCHOR_MAP: StringThe fill extrusion is translated relative to the map. |
FILL_EXTRUSION_TRANSLATE_ANCHOR_VIEWPORT | val FILL_EXTRUSION_TRANSLATE_ANCHOR_VIEWPORT: StringThe fill extrusion is translated relative to the viewport. |
FILL_TRANSLATE_ANCHOR_MAP | val FILL_TRANSLATE_ANCHOR_MAP: StringThe fill is translated relative to the map. |
FILL_TRANSLATE_ANCHOR_VIEWPORT | val FILL_TRANSLATE_ANCHOR_VIEWPORT: StringThe fill is translated relative to the viewport. |
HILLSHADE_ILLUMINATION_ANCHOR_MAP | val HILLSHADE_ILLUMINATION_ANCHOR_MAP: StringThe hillshade illumination is relative to the north direction. |
HILLSHADE_ILLUMINATION_ANCHOR_VIEWPORT | val HILLSHADE_ILLUMINATION_ANCHOR_VIEWPORT: StringThe hillshade illumination is relative to the top of the viewport. |
ICON_ANCHOR_BOTTOM | val ICON_ANCHOR_BOTTOM: StringThe bottom of the icon is placed closest to the anchor. |
ICON_ANCHOR_BOTTOM_LEFT | val ICON_ANCHOR_BOTTOM_LEFT: StringThe bottom left corner of the icon is placed closest to the anchor. |
ICON_ANCHOR_BOTTOM_RIGHT | val ICON_ANCHOR_BOTTOM_RIGHT: StringThe bottom right corner of the icon is placed closest to the anchor. |
ICON_ANCHOR_CENTER | val ICON_ANCHOR_CENTER: StringThe center of the icon is placed closest to the anchor. |
ICON_ANCHOR_LEFT | val ICON_ANCHOR_LEFT: StringThe left side of the icon is placed closest to the anchor. |
ICON_ANCHOR_RIGHT | val ICON_ANCHOR_RIGHT: StringThe right side of the icon is placed closest to the anchor. |
ICON_ANCHOR_TOP | val ICON_ANCHOR_TOP: StringThe top of the icon is placed closest to the anchor. |
ICON_ANCHOR_TOP_LEFT | val ICON_ANCHOR_TOP_LEFT: StringThe top left corner of the icon is placed closest to the anchor. |
ICON_ANCHOR_TOP_RIGHT | val ICON_ANCHOR_TOP_RIGHT: StringThe top right corner of the icon is placed closest to the anchor. |
ICON_PITCH_ALIGNMENT_AUTO | val ICON_PITCH_ALIGNMENT_AUTO: StringAutomatically matches the value of ICON_ROTATION_ALIGNMENT. |
ICON_PITCH_ALIGNMENT_MAP | val ICON_PITCH_ALIGNMENT_MAP: StringThe icon is aligned to the plane of the map. |
ICON_PITCH_ALIGNMENT_VIEWPORT | val ICON_PITCH_ALIGNMENT_VIEWPORT: StringThe icon is aligned to the plane of the viewport. |
ICON_ROTATION_ALIGNMENT_AUTO | val ICON_ROTATION_ALIGNMENT_AUTO: StringWhen SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, this is equivalent to ICON_ROTATION_ALIGNMENT_VIEWPORT. |
ICON_ROTATION_ALIGNMENT_MAP | val ICON_ROTATION_ALIGNMENT_MAP: StringWhen SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, aligns icons east-west. |
ICON_ROTATION_ALIGNMENT_VIEWPORT | val ICON_ROTATION_ALIGNMENT_VIEWPORT: StringProduces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of SYMBOL_PLACEMENT. |
ICON_TEXT_FIT_BOTH | val ICON_TEXT_FIT_BOTH: StringThe icon is scaled in both x- and y-dimensions. |
ICON_TEXT_FIT_HEIGHT | val ICON_TEXT_FIT_HEIGHT: StringThe icon is scaled in the y-dimension to fit the height of the text. |
ICON_TEXT_FIT_NONE | val ICON_TEXT_FIT_NONE: StringThe icon is displayed at its intrinsic aspect ratio. |
ICON_TEXT_FIT_WIDTH | val ICON_TEXT_FIT_WIDTH: StringThe icon is scaled in the x-dimension to fit the width of the text. |
ICON_TRANSLATE_ANCHOR_MAP | val ICON_TRANSLATE_ANCHOR_MAP: StringIcons are translated relative to the map. |
ICON_TRANSLATE_ANCHOR_VIEWPORT | val ICON_TRANSLATE_ANCHOR_VIEWPORT: StringIcons are translated relative to the viewport. |
LINE_CAP_BUTT | val LINE_CAP_BUTT: StringA cap with a squared-off end which is drawn to the exact endpoint of the line. |
LINE_CAP_ROUND | val LINE_CAP_ROUND: StringA cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line’s width and centered on the endpoint of the line. |
LINE_CAP_SQUARE | val LINE_CAP_SQUARE: StringA cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line’s width. |
LINE_JOIN_BEVEL | val LINE_JOIN_BEVEL: StringA join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line’s width. |
LINE_JOIN_MITER | val LINE_JOIN_MITER: StringA join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet. |
LINE_JOIN_ROUND | val LINE_JOIN_ROUND: StringA join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line’s width and centered on the endpoint of the line. |
LINE_TRANSLATE_ANCHOR_MAP | val LINE_TRANSLATE_ANCHOR_MAP: StringThe line is translated relative to the map. |
LINE_TRANSLATE_ANCHOR_VIEWPORT | val LINE_TRANSLATE_ANCHOR_VIEWPORT: StringThe line is translated relative to the viewport. |
NONE | val NONE: StringThe layer is hidden. |
RASTER_RESAMPLING_LINEAR | val RASTER_RESAMPLING_LINEAR: String(Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled |
RASTER_RESAMPLING_NEAREST | val RASTER_RESAMPLING_NEAREST: StringNearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled |
SYMBOL_PLACEMENT_LINE | val SYMBOL_PLACEMENT_LINE: StringThe label is placed along the line of the geometry. |
SYMBOL_PLACEMENT_LINE_CENTER | val SYMBOL_PLACEMENT_LINE_CENTER: StringThe label is placed at the center of the line of the geometry. |
SYMBOL_PLACEMENT_POINT | val SYMBOL_PLACEMENT_POINT: StringThe label is placed at the point where the geometry is located. |
SYMBOL_Z_ORDER_AUTO | val SYMBOL_Z_ORDER_AUTO: StringIf symbol sort key is set, sort based on that. |
SYMBOL_Z_ORDER_SOURCE | val SYMBOL_Z_ORDER_SOURCE: StringSymbols will be rendered in the same order as the source data with no sorting applied. |
SYMBOL_Z_ORDER_VIEWPORT_Y | val SYMBOL_Z_ORDER_VIEWPORT_Y: StringSymbols will be sorted by their y-position relative to the viewport. |
TEXT_ANCHOR_BOTTOM | val TEXT_ANCHOR_BOTTOM: StringThe bottom of the text is placed closest to the anchor. |
TEXT_ANCHOR_BOTTOM_LEFT | val TEXT_ANCHOR_BOTTOM_LEFT: StringThe bottom left corner of the text is placed closest to the anchor. |
TEXT_ANCHOR_BOTTOM_RIGHT | val TEXT_ANCHOR_BOTTOM_RIGHT: StringThe bottom right corner of the text is placed closest to the anchor. |
TEXT_ANCHOR_CENTER | val TEXT_ANCHOR_CENTER: StringThe center of the text is placed closest to the anchor. |
TEXT_ANCHOR_LEFT | val TEXT_ANCHOR_LEFT: StringThe left side of the text is placed closest to the anchor. |
TEXT_ANCHOR_RIGHT | val TEXT_ANCHOR_RIGHT: StringThe right side of the text is placed closest to the anchor. |
TEXT_ANCHOR_TOP | val TEXT_ANCHOR_TOP: StringThe top of the text is placed closest to the anchor. |
TEXT_ANCHOR_TOP_LEFT | val TEXT_ANCHOR_TOP_LEFT: StringThe top left corner of the text is placed closest to the anchor. |
TEXT_ANCHOR_TOP_RIGHT | val TEXT_ANCHOR_TOP_RIGHT: StringThe top right corner of the text is placed closest to the anchor. |
TEXT_JUSTIFY_AUTO | val TEXT_JUSTIFY_AUTO: StringThe text is aligned towards the anchor position. |
TEXT_JUSTIFY_CENTER | val TEXT_JUSTIFY_CENTER: StringThe text is centered. |
TEXT_JUSTIFY_LEFT | val TEXT_JUSTIFY_LEFT: StringThe text is aligned to the left. |
TEXT_JUSTIFY_RIGHT | val TEXT_JUSTIFY_RIGHT: StringThe text is aligned to the right. |
TEXT_PITCH_ALIGNMENT_AUTO | val TEXT_PITCH_ALIGNMENT_AUTO: StringAutomatically matches the value of TEXT_ROTATION_ALIGNMENT. |
TEXT_PITCH_ALIGNMENT_MAP | val TEXT_PITCH_ALIGNMENT_MAP: StringThe text is aligned to the plane of the map. |
TEXT_PITCH_ALIGNMENT_VIEWPORT | val TEXT_PITCH_ALIGNMENT_VIEWPORT: StringThe text is aligned to the plane of the viewport. |
TEXT_ROTATION_ALIGNMENT_AUTO | val TEXT_ROTATION_ALIGNMENT_AUTO: StringWhen SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, this is equivalent to TEXT_ROTATION_ALIGNMENT_VIEWPORT. |
TEXT_ROTATION_ALIGNMENT_MAP | val TEXT_ROTATION_ALIGNMENT_MAP: StringWhen SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, aligns text east-west. |
TEXT_ROTATION_ALIGNMENT_VIEWPORT | val TEXT_ROTATION_ALIGNMENT_VIEWPORT: StringProduces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of SYMBOL_PLACEMENT. |
TEXT_TRANSFORM_LOWERCASE | val TEXT_TRANSFORM_LOWERCASE: StringForces all letters to be displayed in lowercase. |
TEXT_TRANSFORM_NONE | val TEXT_TRANSFORM_NONE: StringThe text is not altered. |
TEXT_TRANSFORM_UPPERCASE | val TEXT_TRANSFORM_UPPERCASE: StringForces all letters to be displayed in uppercase. |
TEXT_TRANSLATE_ANCHOR_MAP | val TEXT_TRANSLATE_ANCHOR_MAP: StringThe text is translated relative to the map. |
TEXT_TRANSLATE_ANCHOR_VIEWPORT | val TEXT_TRANSLATE_ANCHOR_VIEWPORT: StringThe text is translated relative to the viewport. |
TEXT_WRITING_MODE_HORIZONTAL | val TEXT_WRITING_MODE_HORIZONTAL: StringIf a text’s language supports horizontal writing mode, symbols with point placement would be laid out horizontally. |
TEXT_WRITING_MODE_VERTICAL | val TEXT_WRITING_MODE_VERTICAL: StringIf a text’s language supports vertical writing mode, symbols with point placement would be laid out vertically. |
VISIBLE | val VISIBLE: StringThe layer is shown. |
ANCHOR_MAP
val ANCHOR_MAP: String
The position of the light source is aligned to the rotation of the map.
ANCHOR_VIEWPORT
val ANCHOR_VIEWPORT: String
The position of the light source is aligned to the rotation of the viewport.
CIRCLE_PITCH_ALIGNMENT_MAP
val CIRCLE_PITCH_ALIGNMENT_MAP: String
The circle is aligned to the plane of the map.
CIRCLE_PITCH_ALIGNMENT_VIEWPORT
val CIRCLE_PITCH_ALIGNMENT_VIEWPORT: String
The circle is aligned to the plane of the viewport.
CIRCLE_PITCH_SCALE_MAP
val CIRCLE_PITCH_SCALE_MAP: String
Circles are scaled according to their apparent distance to the camera.
CIRCLE_PITCH_SCALE_VIEWPORT
val CIRCLE_PITCH_SCALE_VIEWPORT: String
Circles are not scaled.
CIRCLE_TRANSLATE_ANCHOR_MAP
val CIRCLE_TRANSLATE_ANCHOR_MAP: String
The circle is translated relative to the map.
CIRCLE_TRANSLATE_ANCHOR_VIEWPORT
val CIRCLE_TRANSLATE_ANCHOR_VIEWPORT: String
The circle is translated relative to the viewport.
FILL_EXTRUSION_TRANSLATE_ANCHOR_MAP
val FILL_EXTRUSION_TRANSLATE_ANCHOR_MAP: String
The fill extrusion is translated relative to the map.
FILL_EXTRUSION_TRANSLATE_ANCHOR_VIEWPORT
val FILL_EXTRUSION_TRANSLATE_ANCHOR_VIEWPORT: String
The fill extrusion is translated relative to the viewport.
FILL_TRANSLATE_ANCHOR_MAP
val FILL_TRANSLATE_ANCHOR_MAP: String
The fill is translated relative to the map.
FILL_TRANSLATE_ANCHOR_VIEWPORT
val FILL_TRANSLATE_ANCHOR_VIEWPORT: String
The fill is translated relative to the viewport.
HILLSHADE_ILLUMINATION_ANCHOR_MAP
val HILLSHADE_ILLUMINATION_ANCHOR_MAP: String
The hillshade illumination is relative to the north direction.
HILLSHADE_ILLUMINATION_ANCHOR_VIEWPORT
val HILLSHADE_ILLUMINATION_ANCHOR_VIEWPORT: String
The hillshade illumination is relative to the top of the viewport.
ICON_ANCHOR_BOTTOM
val ICON_ANCHOR_BOTTOM: String
The bottom of the icon is placed closest to the anchor.
ICON_ANCHOR_BOTTOM_LEFT
val ICON_ANCHOR_BOTTOM_LEFT: String
The bottom left corner of the icon is placed closest to the anchor.
ICON_ANCHOR_BOTTOM_RIGHT
val ICON_ANCHOR_BOTTOM_RIGHT: String
The bottom right corner of the icon is placed closest to the anchor.
ICON_ANCHOR_CENTER
val ICON_ANCHOR_CENTER: String
The center of the icon is placed closest to the anchor.
ICON_ANCHOR_LEFT
val ICON_ANCHOR_LEFT: String
The left side of the icon is placed closest to the anchor.
ICON_ANCHOR_RIGHT
val ICON_ANCHOR_RIGHT: String
The right side of the icon is placed closest to the anchor.
ICON_ANCHOR_TOP
val ICON_ANCHOR_TOP: String
The top of the icon is placed closest to the anchor.
ICON_ANCHOR_TOP_LEFT
val ICON_ANCHOR_TOP_LEFT: String
The top left corner of the icon is placed closest to the anchor.
ICON_ANCHOR_TOP_RIGHT
val ICON_ANCHOR_TOP_RIGHT: String
The top right corner of the icon is placed closest to the anchor.
ICON_PITCH_ALIGNMENT_AUTO
val ICON_PITCH_ALIGNMENT_AUTO: String
Automatically matches the value of ICON_ROTATION_ALIGNMENT.
ICON_PITCH_ALIGNMENT_MAP
val ICON_PITCH_ALIGNMENT_MAP: String
The icon is aligned to the plane of the map.
ICON_PITCH_ALIGNMENT_VIEWPORT
val ICON_PITCH_ALIGNMENT_VIEWPORT: String
The icon is aligned to the plane of the viewport.
ICON_ROTATION_ALIGNMENT_AUTO
val ICON_ROTATION_ALIGNMENT_AUTO: String
When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, this is equivalent to ICON_ROTATION_ALIGNMENT_VIEWPORT. When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_LINE or SYMBOL_PLACEMENT_LINE_CENTER, this is equivalent to ICON_ROTATION_ALIGNMENT_MAP.
ICON_ROTATION_ALIGNMENT_MAP
val ICON_ROTATION_ALIGNMENT_MAP: String
When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, aligns icons east-west. When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_LINE or SYMBOL_PLACEMENT_LINE_CENTER, aligns icon x-axes with the line.
ICON_ROTATION_ALIGNMENT_VIEWPORT
val ICON_ROTATION_ALIGNMENT_VIEWPORT: String
Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of SYMBOL_PLACEMENT.
ICON_TEXT_FIT_BOTH
val ICON_TEXT_FIT_BOTH: String
The icon is scaled in both x- and y-dimensions.
ICON_TEXT_FIT_HEIGHT
val ICON_TEXT_FIT_HEIGHT: String
The icon is scaled in the y-dimension to fit the height of the text.
ICON_TEXT_FIT_NONE
val ICON_TEXT_FIT_NONE: String
The icon is displayed at its intrinsic aspect ratio.
ICON_TEXT_FIT_WIDTH
val ICON_TEXT_FIT_WIDTH: String
The icon is scaled in the x-dimension to fit the width of the text.
ICON_TRANSLATE_ANCHOR_MAP
val ICON_TRANSLATE_ANCHOR_MAP: String
Icons are translated relative to the map.
ICON_TRANSLATE_ANCHOR_VIEWPORT
val ICON_TRANSLATE_ANCHOR_VIEWPORT: String
Icons are translated relative to the viewport.
LINE_CAP_BUTT
val LINE_CAP_BUTT: String
A cap with a squared-off end which is drawn to the exact endpoint of the line.
LINE_CAP_ROUND
val LINE_CAP_ROUND: String
A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line’s width and centered on the endpoint of the line.
LINE_CAP_SQUARE
val LINE_CAP_SQUARE: String
A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line’s width.
LINE_JOIN_BEVEL
val LINE_JOIN_BEVEL: String
A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line’s width.
LINE_JOIN_MITER
val LINE_JOIN_MITER: String
A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet.
LINE_JOIN_ROUND
val LINE_JOIN_ROUND: String
A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line’s width and centered on the endpoint of the line.
LINE_TRANSLATE_ANCHOR_MAP
val LINE_TRANSLATE_ANCHOR_MAP: String
The line is translated relative to the map.
LINE_TRANSLATE_ANCHOR_VIEWPORT
val LINE_TRANSLATE_ANCHOR_VIEWPORT: String
The line is translated relative to the viewport.
NONE
val NONE: String
The layer is hidden.
RASTER_RESAMPLING_LINEAR
val RASTER_RESAMPLING_LINEAR: String
(Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled
RASTER_RESAMPLING_NEAREST
val RASTER_RESAMPLING_NEAREST: String
Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled
SYMBOL_PLACEMENT_LINE
val SYMBOL_PLACEMENT_LINE: String
The label is placed along the line of the geometry. Can only be used on LineString and Polygon geometries.
SYMBOL_PLACEMENT_LINE_CENTER
val SYMBOL_PLACEMENT_LINE_CENTER: String
The label is placed at the center of the line of the geometry. Can only be used on LineString and Polygon geometries. Note that a single feature in a vector tile may contain multiple line geometries.
SYMBOL_PLACEMENT_POINT
val SYMBOL_PLACEMENT_POINT: String
The label is placed at the point where the geometry is located.
SYMBOL_Z_ORDER_AUTO
val SYMBOL_Z_ORDER_AUTO: String
If symbol sort key is set, sort based on that. Otherwise sort symbols by their y-position relative to the viewport.
SYMBOL_Z_ORDER_SOURCE
val SYMBOL_Z_ORDER_SOURCE: String
Symbols will be rendered in the same order as the source data with no sorting applied.
SYMBOL_Z_ORDER_VIEWPORT_Y
val SYMBOL_Z_ORDER_VIEWPORT_Y: String
Symbols will be sorted by their y-position relative to the viewport.
TEXT_ANCHOR_BOTTOM
val TEXT_ANCHOR_BOTTOM: String
The bottom of the text is placed closest to the anchor.
TEXT_ANCHOR_BOTTOM_LEFT
val TEXT_ANCHOR_BOTTOM_LEFT: String
The bottom left corner of the text is placed closest to the anchor.
TEXT_ANCHOR_BOTTOM_RIGHT
val TEXT_ANCHOR_BOTTOM_RIGHT: String
The bottom right corner of the text is placed closest to the anchor.
TEXT_ANCHOR_CENTER
val TEXT_ANCHOR_CENTER: String
The center of the text is placed closest to the anchor.
TEXT_ANCHOR_LEFT
val TEXT_ANCHOR_LEFT: String
The left side of the text is placed closest to the anchor.
TEXT_ANCHOR_RIGHT
val TEXT_ANCHOR_RIGHT: String
The right side of the text is placed closest to the anchor.
TEXT_ANCHOR_TOP
val TEXT_ANCHOR_TOP: String
The top of the text is placed closest to the anchor.
TEXT_ANCHOR_TOP_LEFT
val TEXT_ANCHOR_TOP_LEFT: String
The top left corner of the text is placed closest to the anchor.
TEXT_ANCHOR_TOP_RIGHT
val TEXT_ANCHOR_TOP_RIGHT: String
The top right corner of the text is placed closest to the anchor.
TEXT_JUSTIFY_AUTO
val TEXT_JUSTIFY_AUTO: String
The text is aligned towards the anchor position.
TEXT_JUSTIFY_CENTER
val TEXT_JUSTIFY_CENTER: String
The text is centered.
TEXT_JUSTIFY_LEFT
val TEXT_JUSTIFY_LEFT: String
The text is aligned to the left.
TEXT_JUSTIFY_RIGHT
val TEXT_JUSTIFY_RIGHT: String
The text is aligned to the right.
TEXT_PITCH_ALIGNMENT_AUTO
val TEXT_PITCH_ALIGNMENT_AUTO: String
Automatically matches the value of TEXT_ROTATION_ALIGNMENT.
TEXT_PITCH_ALIGNMENT_MAP
val TEXT_PITCH_ALIGNMENT_MAP: String
The text is aligned to the plane of the map.
TEXT_PITCH_ALIGNMENT_VIEWPORT
val TEXT_PITCH_ALIGNMENT_VIEWPORT: String
The text is aligned to the plane of the viewport.
TEXT_ROTATION_ALIGNMENT_AUTO
val TEXT_ROTATION_ALIGNMENT_AUTO: String
When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, this is equivalent to TEXT_ROTATION_ALIGNMENT_VIEWPORT. When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_LINE or SYMBOL_PLACEMENT_LINE_CENTER, this is equivalent to TEXT_ROTATION_ALIGNMENT_MAP.
TEXT_ROTATION_ALIGNMENT_MAP
val TEXT_ROTATION_ALIGNMENT_MAP: String
When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_POINT, aligns text east-west. When SYMBOL_PLACEMENT is set to SYMBOL_PLACEMENT_LINE or SYMBOL_PLACEMENT_LINE_CENTER, aligns text x-axes with the line.
TEXT_ROTATION_ALIGNMENT_VIEWPORT
val TEXT_ROTATION_ALIGNMENT_VIEWPORT: String
Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of SYMBOL_PLACEMENT.
TEXT_TRANSFORM_LOWERCASE
val TEXT_TRANSFORM_LOWERCASE: String
Forces all letters to be displayed in lowercase.
TEXT_TRANSFORM_NONE
val TEXT_TRANSFORM_NONE: String
The text is not altered.
TEXT_TRANSFORM_UPPERCASE
val TEXT_TRANSFORM_UPPERCASE: String
Forces all letters to be displayed in uppercase.
TEXT_TRANSLATE_ANCHOR_MAP
val TEXT_TRANSLATE_ANCHOR_MAP: String
The text is translated relative to the map.
TEXT_TRANSLATE_ANCHOR_VIEWPORT
val TEXT_TRANSLATE_ANCHOR_VIEWPORT: String
The text is translated relative to the viewport.
TEXT_WRITING_MODE_HORIZONTAL
val TEXT_WRITING_MODE_HORIZONTAL: String
If a text’s language supports horizontal writing mode, symbols with point placement would be laid out horizontally.
TEXT_WRITING_MODE_VERTICAL
val TEXT_WRITING_MODE_VERTICAL: String
If a text’s language supports vertical writing mode, symbols with point placement would be laid out vertically.
VISIBLE
val VISIBLE: String
The layer is shown.
ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class ANCHOR
Whether extruded geometries are lit relative to the map or viewport.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
CIRCLE_PITCH_ALIGNMENT
@Retention(value = RetentionPolicy.SOURCE)
annotation class CIRCLE_PITCH_ALIGNMENT
Orientation of circle when map is pitched.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
CIRCLE_PITCH_SCALE
@Retention(value = RetentionPolicy.SOURCE)
annotation class CIRCLE_PITCH_SCALE
Controls the scaling behavior of the circle when the map is pitched.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
CIRCLE_TRANSLATE_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class CIRCLE_TRANSLATE_ANCHOR
Controls the frame of reference for circle-translate
.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
FILL_EXTRUSION_TRANSLATE_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class FILL_EXTRUSION_TRANSLATE_ANCHOR
Controls the frame of reference for fill-extrusion-translate
.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
FILL_TRANSLATE_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class FILL_TRANSLATE_ANCHOR
Controls the frame of reference for fill-translate
.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
HILLSHADE_ILLUMINATION_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class HILLSHADE_ILLUMINATION_ANCHOR
Direction of light source when map is rotated.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
ICON_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class ICON_ANCHOR
Part of the icon placed closest to the anchor.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
ICON_PITCH_ALIGNMENT
@Retention(value = RetentionPolicy.SOURCE)
annotation class ICON_PITCH_ALIGNMENT
Orientation of icon when map is pitched.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
ICON_ROTATION_ALIGNMENT
@Retention(value = RetentionPolicy.SOURCE)
annotation class ICON_ROTATION_ALIGNMENT
In combination with symbol-placement
, determines the rotation behavior of icons.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
ICON_TEXT_FIT
@Retention(value = RetentionPolicy.SOURCE)
annotation class ICON_TEXT_FIT
Scales the icon to fit around the associated text.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
ICON_TRANSLATE_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class ICON_TRANSLATE_ANCHOR
Controls the frame of reference for icon-translate
.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
LINE_CAP
@Retention(value = RetentionPolicy.SOURCE)
annotation class LINE_CAP
The display of line endings.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
LINE_JOIN
@Retention(value = RetentionPolicy.SOURCE)
annotation class LINE_JOIN
The display of lines when joining.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
LINE_TRANSLATE_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class LINE_TRANSLATE_ANCHOR
Controls the frame of reference for line-translate
.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
RASTER_RESAMPLING
@Retention(value = RetentionPolicy.SOURCE)
annotation class RASTER_RESAMPLING
The resampling/interpolation method to use for overscaling, also known as texture magnification filter
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
SYMBOL_PLACEMENT
@Retention(value = RetentionPolicy.SOURCE)
annotation class SYMBOL_PLACEMENT
Label placement relative to its geometry.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
SYMBOL_Z_ORDER
@Retention(value = RetentionPolicy.SOURCE)
annotation class SYMBOL_Z_ORDER
Controls the order in which overlapping symbols in the same layer are rendered
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_ANCHOR
Part of the text placed closest to the anchor.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_JUSTIFY
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_JUSTIFY
Text justification options.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_PITCH_ALIGNMENT
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_PITCH_ALIGNMENT
Orientation of text when map is pitched.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_ROTATION_ALIGNMENT
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_ROTATION_ALIGNMENT
In combination with symbol-placement
, determines the rotation behavior of the individual glyphs forming the text.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_TRANSFORM
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_TRANSFORM
Specifies how to capitalize text, similar to the CSS text-transform
property.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_TRANSLATE_ANCHOR
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_TRANSLATE_ANCHOR
Controls the frame of reference for text-translate
.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
TEXT_WRITING_MODE
@Retention(value = RetentionPolicy.SOURCE)
annotation class TEXT_WRITING_MODE
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. The order of elements in an array define priority order for the placement of an orientation variant.
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
VISIBILITY
@Retention(value = RetentionPolicy.SOURCE)
annotation class VISIBILITY
Functions
Name | Summary |
---|---|
annotationType | abstract fun annotationType(): Class |
equals | abstract fun equals(p: Any): Boolean |
hashCode | abstract fun hashCode(): Int |
toString | abstract fun toString(): String |
PropertyFactory
open class PropertyFactory
Constructs paint/layout properties for Layers
See also
Name | Summary |
---|---|
Layer style documentation | Layer style documentation |
Functions
Name | Summary |
---|---|
backgroundColor | open fun backgroundColor(expression: Expression): PropertyValue<Expression> open fun backgroundColor(value: Int): PropertyValue open fun [backgroundColor](#backgroundcolor)(value: String): [PropertyValue](#propertyvalue) The color with which the background will be drawn. |
backgroundOpacity | open fun backgroundOpacity(expression: Expression): PropertyValue<Expression> open fun backgroundOpacity(value: Float): PropertyValue The opacity at which the background will be drawn. |
backgroundPattern | open fun backgroundPattern(expression: Expression): PropertyValue<Expression> open fun backgroundPattern(value: String): PropertyValue Name of image in sprite to use for drawing an image background. |
circleBlur | open fun circleBlur(expression: Expression): PropertyValue<Expression> open fun circleBlur(value: Float): PropertyValue Amount to blur the circle. |
circleColor | open fun circleColor(expression: Expression): PropertyValue<Expression> open fun circleColor(value: Int): PropertyValue open fun [circleColor](#circlecolor)(value: String): [PropertyValue](#propertyvalue) The fill color of the circle. |
circleOpacity | open fun circleOpacity(expression: Expression): PropertyValue<Expression> open fun circleOpacity(value: Float): PropertyValue The opacity at which the circle will be drawn. |
circlePitchAlignment | open fun circlePitchAlignment(expression: Expression): PropertyValue<Expression> open fun circlePitchAlignment(value: String): PropertyValue Orientation of circle when map is pitched. |
circlePitchScale | open fun circlePitchScale(expression: Expression): PropertyValue<Expression> open fun circlePitchScale(value: String): PropertyValue Controls the scaling behavior of the circle when the map is pitched. |
circleRadius | open fun circleRadius(expression: Expression): PropertyValue<Expression> open fun circleRadius(value: Float): PropertyValue Circle radius. |
circleSortKey | open fun circleSortKey(value: Expression): PropertyValue<Expression> open fun circleSortKey(value: Float): PropertyValue Sorts features in ascending order based on this value. |
circleStrokeColor | open fun circleStrokeColor(expression: Expression): PropertyValue<Expression> open fun circleStrokeColor(value: Int): PropertyValue open fun [circleStrokeColor](#circlestrokecolor)(value: String): [PropertyValue](#propertyvalue) The stroke color of the circle. |
circleStrokeOpacity | open fun circleStrokeOpacity(expression: Expression): PropertyValue<Expression> open fun circleStrokeOpacity(value: Float): PropertyValue The opacity of the circle's stroke. |
circleStrokeWidth | open fun circleStrokeWidth(expression: Expression): PropertyValue<Expression> open fun circleStrokeWidth(value: Float): PropertyValue The width of the circle's stroke. |
circleTranslate | open fun circleTranslate(expression: Expression): PropertyValue<Expression> open fun circleTranslate(value: Array The geometry's offset. |
circleTranslateAnchor | open fun circleTranslateAnchor(expression: Expression): PropertyValue<Expression> open fun circleTranslateAnchor(value: String): PropertyValue Controls the frame of reference for circleTranslate. |
fillAntialias | open fun fillAntialias(expression: Expression): PropertyValue<Expression> open fun fillAntialias(value: Boolean): PropertyValue Whether or not the fill should be antialiased. |
fillColor | open fun fillColor(expression: Expression): PropertyValue<Expression> open fun fillColor(value: Int): PropertyValue open fun [fillColor](#fillcolor)(value: String): [PropertyValue](#propertyvalue) The color of the filled part of this layer. |
fillExtrusionBase | open fun fillExtrusionBase(expression: Expression): PropertyValue<Expression> open fun fillExtrusionBase(value: Float): PropertyValue The height with which to extrude the base of this layer. |
fillExtrusionColor | open fun fillExtrusionColor(expression: Expression): PropertyValue<Expression> open fun fillExtrusionColor(value: Int): PropertyValue open fun [fillExtrusionColor](#fillextrusioncolor)(value: String): [PropertyValue](#propertyvalue) The base color of the extruded fill. |
fillExtrusionHeight | open fun fillExtrusionHeight(expression: Expression): PropertyValue<Expression> open fun fillExtrusionHeight(value: Float): PropertyValue The height with which to extrude this layer. |
fillExtrusionOpacity | open fun fillExtrusionOpacity(expression: Expression): PropertyValue<Expression> open fun fillExtrusionOpacity(value: Float): PropertyValue The opacity of the entire fill extrusion layer. |
fillExtrusionPattern | open fun fillExtrusionPattern(expression: Expression): PropertyValue<Expression> open fun fillExtrusionPattern(value: String): PropertyValue Name of image in sprite to use for drawing images on extruded fills. |
fillExtrusionTranslate | open fun fillExtrusionTranslate(expression: Expression): PropertyValue<Expression> open fun fillExtrusionTranslate(value: Array The geometry's offset. |
fillExtrusionTranslateAnchor | open fun fillExtrusionTranslateAnchor(expression: Expression): PropertyValue<Expression> open fun fillExtrusionTranslateAnchor(value: String): PropertyValue Controls the frame of reference for fillExtrusionTranslate. |
fillExtrusionVerticalGradient | open fun fillExtrusionVerticalGradient(expression: Expression): PropertyValue<Expression> open fun fillExtrusionVerticalGradient(value: Boolean): PropertyValue Whether to apply a vertical gradient to the sides of a fill-extrusion layer. |
fillOpacity | open fun fillOpacity(expression: Expression): PropertyValue<Expression> open fun fillOpacity(value: Float): PropertyValue The opacity of the entire fill layer. |
fillOutlineColor | open fun fillOutlineColor(expression: Expression): PropertyValue<Expression> open fun fillOutlineColor(value: Int): PropertyValue open fun [fillOutlineColor](#filloutlinecolor)(value: String): [PropertyValue](#propertyvalue) The outline color of the fill. |
fillPattern | open fun fillPattern(expression: Expression): PropertyValue<Expression> open fun fillPattern(value: String): PropertyValue Name of image in sprite to use for drawing image fills. |
fillSortKey | open fun fillSortKey(value: Expression): PropertyValue<Expression> open fun fillSortKey(value: Float): PropertyValue Sorts features in ascending order based on this value. |
fillTranslate | open fun fillTranslate(expression: Expression): PropertyValue<Expression> open fun fillTranslate(value: Array The geometry's offset. |
fillTranslateAnchor | open fun fillTranslateAnchor(expression: Expression): PropertyValue<Expression> open fun fillTranslateAnchor(value: String): PropertyValue Controls the frame of reference for fillTranslate. |
heatmapColor | open fun heatmapColor(expression: Expression): PropertyValue<Expression> open fun heatmapColor(value: Int): PropertyValue open fun [heatmapColor](#heatmapcolor)(value: String): [PropertyValue](#propertyvalue) Defines the color of each pixel based on its density value in a heatmap. |
heatmapIntensity | open fun heatmapIntensity(expression: Expression): PropertyValue<Expression> open fun heatmapIntensity(value: Float): PropertyValue Similar to heatmapWeight but controls the intensity of the heatmap globally. |
heatmapOpacity | open fun heatmapOpacity(expression: Expression): PropertyValue<Expression> open fun heatmapOpacity(value: Float): PropertyValue The global opacity at which the heatmap layer will be drawn. |
heatmapRadius | open fun heatmapRadius(expression: Expression): PropertyValue<Expression> open fun heatmapRadius(value: Float): PropertyValue Radius of influence of one heatmap point in density-independent pixels. |
heatmapWeight | open fun heatmapWeight(expression: Expression): PropertyValue<Expression> open fun heatmapWeight(value: Float): PropertyValue A measure of how much an individual point contributes to the heatmap. |
hillshadeAccentColor | open fun hillshadeAccentColor(expression: Expression): PropertyValue<Expression> open fun hillshadeAccentColor(value: Int): PropertyValue open fun [hillshadeAccentColor](#hillshadeaccentcolor)(value: String): [PropertyValue](#propertyvalue) The shading color used to accentuate rugged terrain like sharp cliffs and gorges. |
hillshadeExaggeration | open fun hillshadeExaggeration(expression: Expression): PropertyValue<Expression> open fun hillshadeExaggeration(value: Float): PropertyValue Intensity of the hillshade |
hillshadeHighlightColor | open fun hillshadeHighlightColor(expression: Expression): PropertyValue<Expression> open fun hillshadeHighlightColor(value: Int): PropertyValue open fun [hillshadeHighlightColor](#hillshadehighlightcolor)(value: String): [PropertyValue](#propertyvalue) The shading color of areas that faces towards the light source. |
hillshadeIlluminationAnchor | open fun hillshadeIlluminationAnchor(expression: Expression): PropertyValue<Expression> open fun hillshadeIlluminationAnchor(value: String): PropertyValue Direction of light source when map is rotated. |
hillshadeIlluminationDirection | open fun hillshadeIlluminationDirection(expression: Expression): PropertyValue<Expression> open fun hillshadeIlluminationDirection(value: Float): PropertyValue The direction of the light source used to generate the hillshading with 0 as the top of the viewport if [Property.HILLSHADE_ILLUMINATION_ANCHOR](#property.hillshade_illumination_anchor) is set to `viewport` and due north if [Property.HILLSHADE_ILLUMINATION_ANCHOR](#property.hillshade_illumination_anchor) is set to `map`. |
hillshadeShadowColor | open fun hillshadeShadowColor(expression: Expression): PropertyValue<Expression> open fun hillshadeShadowColor(value: Int): PropertyValue open fun [hillshadeShadowColor](#hillshadeshadowcolor)(value: String): [PropertyValue](#propertyvalue) The shading color of areas that face away from the light source. |
iconAllowOverlap | open fun iconAllowOverlap(value: Expression): PropertyValue<Expression> open fun iconAllowOverlap(value: Boolean): PropertyValue If true, the icon will be visible even if it collides with other previously drawn symbols. |
iconAnchor | open fun iconAnchor(value: Expression): PropertyValue<Expression> open fun iconAnchor(value: String): PropertyValue Part of the icon placed closest to the anchor. |
iconColor | open fun iconColor(expression: Expression): PropertyValue<Expression> open fun iconColor(value: Int): PropertyValue open fun [iconColor](#iconcolor)(value: String): [PropertyValue](#propertyvalue) The color of the icon. |
iconHaloBlur | open fun iconHaloBlur(expression: Expression): PropertyValue<Expression> open fun iconHaloBlur(value: Float): PropertyValue Fade out the halo towards the outside. |
iconHaloColor | open fun iconHaloColor(expression: Expression): PropertyValue<Expression> open fun iconHaloColor(value: Int): PropertyValue open fun [iconHaloColor](#iconhalocolor)(value: String): [PropertyValue](#propertyvalue) The color of the icon's halo. |
iconHaloWidth | open fun iconHaloWidth(expression: Expression): PropertyValue<Expression> open fun iconHaloWidth(value: Float): PropertyValue Distance of halo to the icon outline. |
iconIgnorePlacement | open fun iconIgnorePlacement(value: Expression): PropertyValue<Expression> open fun iconIgnorePlacement(value: Boolean): PropertyValue If true, other symbols can be visible even if they collide with the icon. |
iconImage | open fun iconImage(value: Expression): PropertyValue<Expression> open fun iconImage(value: String): PropertyValue Name of image in sprite to use for drawing an image background. |
iconKeepUpright | open fun iconKeepUpright(value: Expression): PropertyValue<Expression> open fun iconKeepUpright(value: Boolean): PropertyValue If true, the icon may be flipped to prevent it from being rendered upside-down. |
iconOffset | open fun iconOffset(value: Expression): PropertyValue<Expression> open fun iconOffset(value: Array Offset distance of icon from its anchor. |
iconOpacity | open fun iconOpacity(expression: Expression): PropertyValue<Expression> open fun iconOpacity(value: Float): PropertyValue The opacity at which the icon will be drawn. |
iconOptional | open fun iconOptional(value: Expression): PropertyValue<Expression> open fun iconOptional(value: Boolean): PropertyValue If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. |
iconPadding | open fun iconPadding(value: Expression): PropertyValue<Expression> open fun iconPadding(value: Float): PropertyValue Size of the additional area around the icon bounding box used for detecting symbol collisions. |
iconPitchAlignment | open fun iconPitchAlignment(value: Expression): PropertyValue<Expression> open fun iconPitchAlignment(value: String): PropertyValue Orientation of icon when map is pitched. |
iconRotate | open fun iconRotate(value: Expression): PropertyValue<Expression> open fun iconRotate(value: Float): PropertyValue Rotates the icon clockwise. |
iconRotationAlignment | open fun iconRotationAlignment(value: Expression): PropertyValue<Expression> open fun iconRotationAlignment(value: String): PropertyValue In combination with [Property.SYMBOL_PLACEMENT](#property.symbol_placement), determines the rotation behavior of icons. |
iconSize | open fun iconSize(value: Expression): PropertyValue<Expression> open fun iconSize(value: Float): PropertyValue Scales the original size of the icon by the provided factor. |
iconTextFit | open fun iconTextFit(value: Expression): PropertyValue<Expression> open fun iconTextFit(value: String): PropertyValue Scales the icon to fit around the associated text. |
iconTextFitPadding | open fun iconTextFitPadding(value: Expression): PropertyValue<Expression> open fun iconTextFitPadding(value: Array Size of the additional area added to dimensions determined by [Property.ICON_TEXT_FIT](#property.icon_text_fit), in clockwise order: top, right, bottom, left. |
iconTranslate | open fun iconTranslate(expression: Expression): PropertyValue<Expression> open fun iconTranslate(value: Array Distance that the icon's anchor is moved from its original placement. |
iconTranslateAnchor | open fun iconTranslateAnchor(expression: Expression): PropertyValue<Expression> open fun iconTranslateAnchor(value: String): PropertyValue Controls the frame of reference for iconTranslate. |
lineBlur | open fun lineBlur(expression: Expression): PropertyValue<Expression> open fun lineBlur(value: Float): PropertyValue Blur applied to the line, in density-independent pixels. |
lineCap | open fun lineCap(value: Expression): PropertyValue<Expression> open fun lineCap(value: String): PropertyValue The display of line endings. |
lineColor | open fun lineColor(expression: Expression): PropertyValue<Expression> open fun lineColor(value: Int): PropertyValue open fun [lineColor](#linecolor)(value: String): [PropertyValue](#propertyvalue) The color with which the line will be drawn. |
lineDasharray | open fun lineDasharray(expression: Expression): PropertyValue<Expression> open fun lineDasharray(value: Array Specifies the lengths of the alternating dashes and gaps that form the dash pattern. |
lineGapWidth | open fun lineGapWidth(expression: Expression): PropertyValue<Expression> open fun lineGapWidth(value: Float): PropertyValue Draws a line casing outside of a line's actual path. |
lineGradient | open fun lineGradient(expression: Expression): PropertyValue<Expression> open fun lineGradient(value: Int): PropertyValue open fun [lineGradient](#linegradient)(value: String): [PropertyValue](#propertyvalue) Defines a gradient with which to color a line feature. |
lineJoin | open fun lineJoin(value: Expression): PropertyValue<Expression> open fun lineJoin(value: String): PropertyValue The display of lines when joining. |
lineMiterLimit | open fun lineMiterLimit(value: Expression): PropertyValue<Expression> open fun lineMiterLimit(value: Float): PropertyValue Used to automatically convert miter joins to bevel joins for sharp angles. |
lineOffset | open fun lineOffset(expression: Expression): PropertyValue<Expression> open fun lineOffset(value: Float): PropertyValue The line's offset. |
lineOpacity | open fun lineOpacity(expression: Expression): PropertyValue<Expression> open fun lineOpacity(value: Float): PropertyValue The opacity at which the line will be drawn. |
linePattern | open fun linePattern(expression: Expression): PropertyValue<Expression> open fun linePattern(value: String): PropertyValue Name of image in sprite to use for drawing image lines. |
lineRoundLimit | open fun lineRoundLimit(value: Expression): PropertyValue<Expression> open fun lineRoundLimit(value: Float): PropertyValue Used to automatically convert round joins to miter joins for shallow angles. |
lineSortKey | open fun lineSortKey(value: Expression): PropertyValue<Expression> open fun lineSortKey(value: Float): PropertyValue Sorts features in ascending order based on this value. |
lineTranslate | open fun lineTranslate(expression: Expression): PropertyValue<Expression> open fun lineTranslate(value: Array The geometry's offset. |
lineTranslateAnchor | open fun lineTranslateAnchor(expression: Expression): PropertyValue<Expression> open fun lineTranslateAnchor(value: String): PropertyValue Controls the frame of reference for lineTranslate. |
lineWidth | open fun lineWidth(expression: Expression): PropertyValue<Expression> open fun lineWidth(value: Float): PropertyValue Stroke thickness. |
rasterBrightnessMax | open fun rasterBrightnessMax(expression: Expression): PropertyValue<Expression> open fun rasterBrightnessMax(value: Float): PropertyValue Increase or reduce the brightness of the image. |
rasterBrightnessMin | open fun rasterBrightnessMin(expression: Expression): PropertyValue<Expression> open fun rasterBrightnessMin(value: Float): PropertyValue Increase or reduce the brightness of the image. |
rasterContrast | open fun rasterContrast(expression: Expression): PropertyValue<Expression> open fun rasterContrast(value: Float): PropertyValue Increase or reduce the contrast of the image. |
rasterFadeDuration | open fun rasterFadeDuration(expression: Expression): PropertyValue<Expression> open fun rasterFadeDuration(value: Float): PropertyValue Fade duration when a new tile is added. |
rasterHueRotate | open fun rasterHueRotate(expression: Expression): PropertyValue<Expression> open fun rasterHueRotate(value: Float): PropertyValue Rotates hues around the color wheel. |
rasterOpacity | open fun rasterOpacity(expression: Expression): PropertyValue<Expression> open fun rasterOpacity(value: Float): PropertyValue The opacity at which the image will be drawn. |
rasterResampling | open fun rasterResampling(expression: Expression): PropertyValue<Expression> open fun rasterResampling(value: String): PropertyValue The resampling/interpolation method to use for overscaling, also known as texture magnification filter |
rasterSaturation | open fun rasterSaturation(expression: Expression): PropertyValue<Expression> open fun rasterSaturation(value: Float): PropertyValue Increase or reduce the saturation of the image. |
symbolAvoidEdges | open fun symbolAvoidEdges(value: Expression): PropertyValue<Expression> open fun symbolAvoidEdges(value: Boolean): PropertyValue If true, the symbols will not cross tile edges to avoid mutual collisions. |
symbolPlacement | open fun symbolPlacement(value: Expression): PropertyValue<Expression> open fun symbolPlacement(value: String): PropertyValue Label placement relative to its geometry. |
symbolSortKey | open fun symbolSortKey(value: Expression): PropertyValue<Expression> open fun symbolSortKey(value: Float): PropertyValue Sorts features in ascending order based on this value. |
symbolSpacing | open fun symbolSpacing(value: Expression): PropertyValue<Expression> open fun symbolSpacing(value: Float): PropertyValue Distance between two symbol anchors. |
symbolZOrder | open fun symbolZOrder(value: Expression): PropertyValue<Expression> open fun symbolZOrder(value: String): PropertyValue Controls the order in which overlapping symbols in the same layer are rendered |
textAllowOverlap | open fun textAllowOverlap(value: Expression): PropertyValue<Expression> open fun textAllowOverlap(value: Boolean): PropertyValue If true, the text will be visible even if it collides with other previously drawn symbols. |
textAnchor | open fun textAnchor(value: Expression): PropertyValue<Expression> open fun textAnchor(value: String): PropertyValue Part of the text placed closest to the anchor. |
textColor | open fun textColor(expression: Expression): PropertyValue<Expression> open fun textColor(value: Int): PropertyValue open fun [textColor](#textcolor)(value: String): [PropertyValue](#propertyvalue) The color with which the text will be drawn. |
textField | open fun textField(value: Expression): PropertyValue<Expression> open fun textField(value: Formatted): PropertyValue<Formatted> open fun textField(value: String): PropertyValue Value to use for a text label. |
textFont | open fun textFont(value: Expression): PropertyValue<Expression> open fun textFont(value: Array Font stack to use for displaying text. |
textHaloBlur | open fun textHaloBlur(expression: Expression): PropertyValue<Expression> open fun textHaloBlur(value: Float): PropertyValue The halo's fadeout distance towards the outside. |
textHaloColor | open fun textHaloColor(expression: Expression): PropertyValue<Expression> open fun textHaloColor(value: Int): PropertyValue open fun [textHaloColor](#texthalocolor)(value: String): [PropertyValue](#propertyvalue) The color of the text's halo, which helps it stand out from backgrounds. |
textHaloWidth | open fun textHaloWidth(expression: Expression): PropertyValue<Expression> open fun textHaloWidth(value: Float): PropertyValue Distance of halo to the font outline. |
textIgnorePlacement | open fun textIgnorePlacement(value: Expression): PropertyValue<Expression> open fun textIgnorePlacement(value: Boolean): PropertyValue If true, other symbols can be visible even if they collide with the text. |
textJustify | open fun textJustify(value: Expression): PropertyValue<Expression> open fun textJustify(value: String): PropertyValue Text justification options. |
textKeepUpright | open fun textKeepUpright(value: Expression): PropertyValue<Expression> open fun textKeepUpright(value: Boolean): PropertyValue If true, the text may be flipped vertically to prevent it from being rendered upside-down. |
textLetterSpacing | open fun textLetterSpacing(value: Expression): PropertyValue<Expression> open fun textLetterSpacing(value: Float): PropertyValue Text tracking amount. |
textLineHeight | open fun textLineHeight(value: Expression): PropertyValue<Expression> open fun textLineHeight(value: Float): PropertyValue Text leading value for multi-line text. |
textMaxAngle | open fun textMaxAngle(value: Expression): PropertyValue<Expression> open fun textMaxAngle(value: Float): PropertyValue Maximum angle change between adjacent characters. |
textMaxWidth | open fun textMaxWidth(value: Expression): PropertyValue<Expression> open fun textMaxWidth(value: Float): PropertyValue The maximum line width for text wrapping. |
textOffset | open fun textOffset(value: Expression): PropertyValue<Expression> open fun textOffset(value: Array Offset distance of text from its anchor. |
textOpacity | open fun textOpacity(expression: Expression): PropertyValue<Expression> open fun textOpacity(value: Float): PropertyValue The opacity at which the text will be drawn. |
textOptional | open fun textOptional(value: Expression): PropertyValue<Expression> open fun textOptional(value: Boolean): PropertyValue If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. |
textPadding | open fun textPadding(value: Expression): PropertyValue<Expression> open fun textPadding(value: Float): PropertyValue Size of the additional area around the text bounding box used for detecting symbol collisions. |
textPitchAlignment | open fun textPitchAlignment(value: Expression): PropertyValue<Expression> open fun textPitchAlignment(value: String): PropertyValue Orientation of text when map is pitched. |
textRadialOffset | open fun textRadialOffset(value: Expression): PropertyValue<Expression> open fun textRadialOffset(value: Float): PropertyValue Radial offset of text, in the direction of the symbol's anchor. |
textRotate | open fun textRotate(value: Expression): PropertyValue<Expression> open fun textRotate(value: Float): PropertyValue Rotates the text clockwise. |
textRotationAlignment | open fun textRotationAlignment(value: Expression): PropertyValue<Expression> open fun textRotationAlignment(value: String): PropertyValue In combination with [Property.SYMBOL_PLACEMENT](#property.symbol_placement), determines the rotation behavior of the individual glyphs forming the text. |
textSize | open fun textSize(value: Expression): PropertyValue<Expression> open fun textSize(value: Float): PropertyValue Font size. |
textTransform | open fun textTransform(value: Expression): PropertyValue<Expression> open fun textTransform(value: String): PropertyValue Specifies how to capitalize text, similar to the CSS textTransform property. |
textTranslate | open fun textTranslate(expression: Expression): PropertyValue<Expression> open fun textTranslate(value: Array Distance that the text's anchor is moved from its original placement. |
textTranslateAnchor | open fun textTranslateAnchor(expression: Expression): PropertyValue<Expression> open fun textTranslateAnchor(value: String): PropertyValue Controls the frame of reference for textTranslate. |
textVariableAnchor | open fun textVariableAnchor(value: Expression): PropertyValue<Expression> open fun textVariableAnchor(value: Array To increase the chance of placing high-priority labels on the map, you can provide an array of [Property.TEXT_ANCHOR](#property.text_anchor) locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. |
textWritingMode | open fun textWritingMode(value: Expression): PropertyValue<Expression> open fun textWritingMode(value: Array The property allows control over a symbol's orientation. |
visibility | open fun visibility(value: String): PropertyValue Set the property visibility. |
backgroundColor
open fun backgroundColor(value: Int): PropertyValue
The color with which the background will be drawn.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun backgroundColor(value: String): PropertyValue
The color with which the background will be drawn.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun backgroundColor(expression: Expression): PropertyValue<Expression>
The color with which the background will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
backgroundOpacity
open fun backgroundOpacity(value: Float): PropertyValue
The opacity at which the background will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun backgroundOpacity(expression: Expression): PropertyValue<Expression>
The opacity at which the background will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
backgroundPattern
open fun backgroundPattern(value: String): PropertyValue
Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun backgroundPattern(expression: Expression): PropertyValue<Expression>
Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleBlur
open fun circleBlur(value: Float): PropertyValue
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun circleBlur(expression: Expression): PropertyValue<Expression>
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleColor
open fun circleColor(value: Int): PropertyValue
The fill color of the circle.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun circleColor(value: String): PropertyValue
The fill color of the circle.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun circleColor(expression: Expression): PropertyValue<Expression>
The fill color of the circle.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleOpacity
open fun circleOpacity(value: Float): PropertyValue
The opacity at which the circle will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun circleOpacity(expression: Expression): PropertyValue<Expression>
The opacity at which the circle will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circlePitchAlignment
open fun circlePitchAlignment(value: String): PropertyValue
Orientation of circle when map is pitched.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun circlePitchAlignment(expression: Expression): PropertyValue<Expression>
Orientation of circle when map is pitched.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circlePitchScale
open fun circlePitchScale(value: String): PropertyValue
Controls the scaling behavior of the circle when the map is pitched.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun circlePitchScale(expression: Expression): PropertyValue<Expression>
Controls the scaling behavior of the circle when the map is pitched.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleRadius
open fun circleRadius(value: Float): PropertyValue
Circle radius.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun circleRadius(expression: Expression): PropertyValue<Expression>
Circle radius.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleSortKey
open fun circleSortKey(value: Float): PropertyValue
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun circleSortKey(value: Expression): PropertyValue<Expression>
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
circleStrokeColor
open fun circleStrokeColor(value: Int): PropertyValue
The stroke color of the circle.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun circleStrokeColor(value: String): PropertyValue
The stroke color of the circle.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun circleStrokeColor(expression: Expression): PropertyValue<Expression>
The stroke color of the circle.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleStrokeOpacity
open fun circleStrokeOpacity(value: Float): PropertyValue
The opacity of the circle’s stroke.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun circleStrokeOpacity(expression: Expression): PropertyValue<Expression>
The opacity of the circle’s stroke.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleStrokeWidth
open fun circleStrokeWidth(value: Float): PropertyValue
The width of the circle’s stroke. Strokes are placed outside of the circleRadius.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun circleStrokeWidth(expression: Expression): PropertyValue<Expression>
The width of the circle’s stroke. Strokes are placed outside of the circleRadius.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleTranslateAnchor
open fun circleTranslateAnchor(value: String): PropertyValue
Controls the frame of reference for circleTranslate.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun circleTranslateAnchor(expression: Expression): PropertyValue<Expression>
Controls the frame of reference for circleTranslate.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
circleTranslate
open fun circleTranslate(value: Array
The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun circleTranslate(expression: Expression): PropertyValue<Expression>
The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillAntialias
open fun fillAntialias(value: Boolean): PropertyValue
Whether or not the fill should be antialiased.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun fillAntialias(expression: Expression): PropertyValue<Expression>
Whether or not the fill should be antialiased.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillColor
open fun fillColor(value: Int): PropertyValue
The color of the filled part of this layer. This color can be specified as rgba
with an alpha component and the color’s opacity will not affect the opacity of the 1px stroke, if it is used.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun fillColor(value: String): PropertyValue
The color of the filled part of this layer. This color can be specified as rgba
with an alpha component and the color’s opacity will not affect the opacity of the 1px stroke, if it is used.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillColor(expression: Expression): PropertyValue<Expression>
The color of the filled part of this layer. This color can be specified as rgba
with an alpha component and the color’s opacity will not affect the opacity of the 1px stroke, if it is used.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionBase
open fun fillExtrusionBase(value: Float): PropertyValue
The height with which to extrude the base of this layer. Must be less than or equal to fillExtrusionHeight.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun fillExtrusionBase(expression: Expression): PropertyValue<Expression>
The height with which to extrude the base of this layer. Must be less than or equal to fillExtrusionHeight.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionColor
open fun fillExtrusionColor(value: Int): PropertyValue
The base color of the extruded fill. The extrusion’s surfaces will be shaded differently based on this color in combination with the root light
settings. If this color is specified as rgba
with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity to set layer opacity.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun fillExtrusionColor(value: String): PropertyValue
The base color of the extruded fill. The extrusion’s surfaces will be shaded differently based on this color in combination with the root light
settings. If this color is specified as rgba
with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity to set layer opacity.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillExtrusionColor(expression: Expression): PropertyValue<Expression>
The base color of the extruded fill. The extrusion’s surfaces will be shaded differently based on this color in combination with the root light
settings. If this color is specified as rgba
with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity to set layer opacity.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionHeight
open fun fillExtrusionHeight(value: Float): PropertyValue
The height with which to extrude this layer.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun fillExtrusionHeight(expression: Expression): PropertyValue<Expression>
The height with which to extrude this layer.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionOpacity
open fun fillExtrusionOpacity(value: Float): PropertyValue
The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun fillExtrusionOpacity(expression: Expression): PropertyValue<Expression>
The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionPattern
open fun fillExtrusionPattern(value: String): PropertyValue
Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillExtrusionPattern(expression: Expression): PropertyValue<Expression>
Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionTranslateAnchor
open fun fillExtrusionTranslateAnchor(value: String): PropertyValue
Controls the frame of reference for fillExtrusionTranslate.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillExtrusionTranslateAnchor(expression: Expression): PropertyValue<Expression>
Controls the frame of reference for fillExtrusionTranslate.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionTranslate
open fun fillExtrusionTranslate(value: Array
The geometry’s offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun fillExtrusionTranslate(expression: Expression): PropertyValue<Expression>
The geometry’s offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillExtrusionVerticalGradient
open fun fillExtrusionVerticalGradient(value: Boolean): PropertyValue
Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun fillExtrusionVerticalGradient(expression: Expression): PropertyValue<Expression>
Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillOpacity
open fun fillOpacity(value: Float): PropertyValue
The opacity of the entire fill layer. In contrast to the fillColor, this value will also affect the 1px stroke around the fill, if the stroke is used.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun fillOpacity(expression: Expression): PropertyValue<Expression>
The opacity of the entire fill layer. In contrast to the fillColor, this value will also affect the 1px stroke around the fill, if the stroke is used.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillOutlineColor
open fun fillOutlineColor(value: Int): PropertyValue
The outline color of the fill. Matches the value of fillColor if unspecified.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun fillOutlineColor(value: String): PropertyValue
The outline color of the fill. Matches the value of fillColor if unspecified.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillOutlineColor(expression: Expression): PropertyValue<Expression>
The outline color of the fill. Matches the value of fillColor if unspecified.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillPattern
open fun fillPattern(value: String): PropertyValue
Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillPattern(expression: Expression): PropertyValue<Expression>
Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillSortKey
open fun fillSortKey(value: Float): PropertyValue
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun fillSortKey(value: Expression): PropertyValue<Expression>
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
fillTranslateAnchor
open fun fillTranslateAnchor(value: String): PropertyValue
Controls the frame of reference for fillTranslate.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun fillTranslateAnchor(expression: Expression): PropertyValue<Expression>
Controls the frame of reference for fillTranslate.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
fillTranslate
open fun fillTranslate(value: Array
The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun fillTranslate(expression: Expression): PropertyValue<Expression>
The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
heatmapColor
open fun heatmapColor(value: Int): PropertyValue
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"]
as input.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun heatmapColor(value: String): PropertyValue
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"]
as input.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun heatmapColor(expression: Expression): PropertyValue<Expression>
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"]
as input.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
heatmapIntensity
open fun heatmapIntensity(value: Float): PropertyValue
Similar to heatmapWeight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun heatmapIntensity(expression: Expression): PropertyValue<Expression>
Similar to heatmapWeight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
heatmapOpacity
open fun heatmapOpacity(value: Float): PropertyValue
The global opacity at which the heatmap layer will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun heatmapOpacity(expression: Expression): PropertyValue<Expression>
The global opacity at which the heatmap layer will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
heatmapRadius
open fun heatmapRadius(value: Float): PropertyValue
Radius of influence of one heatmap point in density-independent pixels. Increasing the value makes the heatmap smoother, but less detailed.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun heatmapRadius(expression: Expression): PropertyValue<Expression>
Radius of influence of one heatmap point in density-independent pixels. Increasing the value makes the heatmap smoother, but less detailed.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
heatmapWeight
open fun heatmapWeight(value: Float): PropertyValue
A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun heatmapWeight(expression: Expression): PropertyValue<Expression>
A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
hillshadeAccentColor
open fun hillshadeAccentColor(value: Int): PropertyValue
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun hillshadeAccentColor(value: String): PropertyValue
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun hillshadeAccentColor(expression: Expression): PropertyValue<Expression>
The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
hillshadeExaggeration
open fun hillshadeExaggeration(value: Float): PropertyValue
Intensity of the hillshade
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun hillshadeExaggeration(expression: Expression): PropertyValue<Expression>
Intensity of the hillshade
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
hillshadeHighlightColor
open fun hillshadeHighlightColor(value: Int): PropertyValue
The shading color of areas that faces towards the light source.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun hillshadeHighlightColor(value: String): PropertyValue
The shading color of areas that faces towards the light source.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun hillshadeHighlightColor(expression: Expression): PropertyValue<Expression>
The shading color of areas that faces towards the light source.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
hillshadeIlluminationAnchor
open fun hillshadeIlluminationAnchor(value: String): PropertyValue
Direction of light source when map is rotated.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun hillshadeIlluminationAnchor(expression: Expression): PropertyValue<Expression>
Direction of light source when map is rotated.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
hillshadeIlluminationDirection
open fun hillshadeIlluminationDirection(value: Float): PropertyValue
The direction of the light source used to generate the hillshading with 0 as the top of the viewport if Property.HILLSHADE_ILLUMINATION_ANCHOR is set to viewport
and due north if Property.HILLSHADE_ILLUMINATION_ANCHOR is set to map
.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun hillshadeIlluminationDirection(expression: Expression): PropertyValue<Expression>
The direction of the light source used to generate the hillshading with 0 as the top of the viewport if Property.HILLSHADE_ILLUMINATION_ANCHOR is set to viewport
and due north if Property.HILLSHADE_ILLUMINATION_ANCHOR is set to map
.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
hillshadeShadowColor
open fun hillshadeShadowColor(value: Int): PropertyValue
The shading color of areas that face away from the light source.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun hillshadeShadowColor(value: String): PropertyValue
The shading color of areas that face away from the light source.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun hillshadeShadowColor(expression: Expression): PropertyValue<Expression>
The shading color of areas that face away from the light source.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconAllowOverlap
open fun iconAllowOverlap(value: Boolean): PropertyValue
If true, the icon will be visible even if it collides with other previously drawn symbols.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun iconAllowOverlap(value: Expression): PropertyValue<Expression>
If true, the icon will be visible even if it collides with other previously drawn symbols.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
iconAnchor
open fun iconAnchor(value: String): PropertyValue
Part of the icon placed closest to the anchor.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconAnchor(value: Expression): PropertyValue<Expression>
Part of the icon placed closest to the anchor.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
iconColor
open fun iconColor(value: Int): PropertyValue
The color of the icon. This can only be used with sdf icons.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun iconColor(value: String): PropertyValue
The color of the icon. This can only be used with sdf icons.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconColor(expression: Expression): PropertyValue<Expression>
The color of the icon. This can only be used with sdf icons.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconHaloBlur
open fun iconHaloBlur(value: Float): PropertyValue
Fade out the halo towards the outside.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun iconHaloBlur(expression: Expression): PropertyValue<Expression>
Fade out the halo towards the outside.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconHaloColor
open fun iconHaloColor(value: Int): PropertyValue
The color of the icon’s halo. Icon halos can only be used with SDF icons.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun iconHaloColor(value: String): PropertyValue
The color of the icon’s halo. Icon halos can only be used with SDF icons.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconHaloColor(expression: Expression): PropertyValue<Expression>
The color of the icon’s halo. Icon halos can only be used with SDF icons.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconHaloWidth
open fun iconHaloWidth(value: Float): PropertyValue
Distance of halo to the icon outline.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun iconHaloWidth(expression: Expression): PropertyValue<Expression>
Distance of halo to the icon outline.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconIgnorePlacement
open fun iconIgnorePlacement(value: Boolean): PropertyValue
If true, other symbols can be visible even if they collide with the icon.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun iconIgnorePlacement(value: Expression): PropertyValue<Expression>
If true, other symbols can be visible even if they collide with the icon.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
iconImage
open fun iconImage(value: String): PropertyValue
Name of image in sprite to use for drawing an image background.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconImage(value: Expression): PropertyValue<Expression>
Name of image in sprite to use for drawing an image background.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
iconKeepUpright
open fun iconKeepUpright(value: Boolean): PropertyValue
If true, the icon may be flipped to prevent it from being rendered upside-down.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun iconKeepUpright(value: Expression): PropertyValue<Expression>
If true, the icon may be flipped to prevent it from being rendered upside-down.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
iconOffset
open fun iconOffset(value: Array
Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of iconSize to obtain the final offset in density-independent pixels. When combined with iconRotate the offset will be as if the rotated direction was up.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun iconOffset(value: Expression): PropertyValue<Expression>
Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of iconSize to obtain the final offset in density-independent pixels. When combined with iconRotate the offset will be as if the rotated direction was up.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
iconOpacity
open fun iconOpacity(value: Float): PropertyValue
The opacity at which the icon will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun iconOpacity(expression: Expression): PropertyValue<Expression>
The opacity at which the icon will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconOptional
open fun iconOptional(value: Boolean): PropertyValue
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun iconOptional(value: Expression): PropertyValue<Expression>
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
iconPadding
open fun iconPadding(value: Float): PropertyValue
Size of the additional area around the icon bounding box used for detecting symbol collisions.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun iconPadding(value: Expression): PropertyValue<Expression>
Size of the additional area around the icon bounding box used for detecting symbol collisions.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
iconPitchAlignment
open fun iconPitchAlignment(value: String): PropertyValue
Orientation of icon when map is pitched.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconPitchAlignment(value: Expression): PropertyValue<Expression>
Orientation of icon when map is pitched.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
iconRotate
open fun iconRotate(value: Float): PropertyValue
Rotates the icon clockwise.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun iconRotate(value: Expression): PropertyValue<Expression>
Rotates the icon clockwise.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
iconRotationAlignment
open fun iconRotationAlignment(value: String): PropertyValue
In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of icons.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconRotationAlignment(value: Expression): PropertyValue<Expression>
In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of icons.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
iconSize
open fun iconSize(value: Float): PropertyValue
Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by iconSize. 1 is the original size; 3 triples the size of the image.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun iconSize(value: Expression): PropertyValue<Expression>
Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by iconSize. 1 is the original size; 3 triples the size of the image.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
iconTextFitPadding
open fun iconTextFitPadding(value: Array
Size of the additional area added to dimensions determined by Property.ICON_TEXT_FIT, in clockwise order: top, right, bottom, left.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun iconTextFitPadding(value: Expression): PropertyValue<Expression>
Size of the additional area added to dimensions determined by Property.ICON_TEXT_FIT, in clockwise order: top, right, bottom, left.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
iconTextFit
open fun iconTextFit(value: String): PropertyValue
Scales the icon to fit around the associated text.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconTextFit(value: Expression): PropertyValue<Expression>
Scales the icon to fit around the associated text.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
iconTranslateAnchor
open fun iconTranslateAnchor(value: String): PropertyValue
Controls the frame of reference for iconTranslate.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun iconTranslateAnchor(expression: Expression): PropertyValue<Expression>
Controls the frame of reference for iconTranslate.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
iconTranslate
open fun iconTranslate(value: Array
Distance that the icon’s anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun iconTranslate(expression: Expression): PropertyValue<Expression>
Distance that the icon’s anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineBlur
open fun lineBlur(value: Float): PropertyValue
Blur applied to the line, in density-independent pixels.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineBlur(expression: Expression): PropertyValue<Expression>
Blur applied to the line, in density-independent pixels.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineCap
open fun lineCap(value: String): PropertyValue
The display of line endings.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun lineCap(value: Expression): PropertyValue<Expression>
The display of line endings.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
lineColor
open fun lineColor(value: Int): PropertyValue
The color with which the line will be drawn.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun lineColor(value: String): PropertyValue
The color with which the line will be drawn.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun lineColor(expression: Expression): PropertyValue<Expression>
The color with which the line will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineDasharray
open fun lineDasharray(value: Array
Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true
specified won’t render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun lineDasharray(expression: Expression): PropertyValue<Expression>
Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true
specified won’t render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineGapWidth
open fun lineGapWidth(value: Float): PropertyValue
Draws a line casing outside of a line’s actual path. Value indicates the width of the inner gap.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineGapWidth(expression: Expression): PropertyValue<Expression>
Draws a line casing outside of a line’s actual path. Value indicates the width of the inner gap.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineGradient
open fun lineGradient(value: Int): PropertyValue
Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true
.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun lineGradient(value: String): PropertyValue
Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true
.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun lineGradient(expression: Expression): PropertyValue<Expression>
Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify "lineMetrics": true
.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineJoin
open fun lineJoin(value: String): PropertyValue
The display of lines when joining.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun lineJoin(value: Expression): PropertyValue<Expression>
The display of lines when joining.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
lineMiterLimit
open fun lineMiterLimit(value: Float): PropertyValue
Used to automatically convert miter joins to bevel joins for sharp angles.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineMiterLimit(value: Expression): PropertyValue<Expression>
Used to automatically convert miter joins to bevel joins for sharp angles.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
lineOffset
open fun lineOffset(value: Float): PropertyValue
The line’s offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineOffset(expression: Expression): PropertyValue<Expression>
The line’s offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineOpacity
open fun lineOpacity(value: Float): PropertyValue
The opacity at which the line will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineOpacity(expression: Expression): PropertyValue<Expression>
The opacity at which the line will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
linePattern
open fun linePattern(value: String): PropertyValue
Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun linePattern(expression: Expression): PropertyValue<Expression>
Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineRoundLimit
open fun lineRoundLimit(value: Float): PropertyValue
Used to automatically convert round joins to miter joins for shallow angles.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineRoundLimit(value: Expression): PropertyValue<Expression>
Used to automatically convert round joins to miter joins for shallow angles.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
lineSortKey
open fun lineSortKey(value: Float): PropertyValue
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineSortKey(value: Expression): PropertyValue<Expression>
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
lineTranslateAnchor
open fun lineTranslateAnchor(value: String): PropertyValue
Controls the frame of reference for lineTranslate.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun lineTranslateAnchor(expression: Expression): PropertyValue<Expression>
Controls the frame of reference for lineTranslate.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineTranslate
open fun lineTranslate(value: Array
The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun lineTranslate(expression: Expression): PropertyValue<Expression>
The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
lineWidth
open fun lineWidth(value: Float): PropertyValue
Stroke thickness.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun lineWidth(expression: Expression): PropertyValue<Expression>
Stroke thickness.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterBrightnessMax
open fun rasterBrightnessMax(value: Float): PropertyValue
Increase or reduce the brightness of the image. The value is the maximum brightness.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterBrightnessMax(expression: Expression): PropertyValue<Expression>
Increase or reduce the brightness of the image. The value is the maximum brightness.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterBrightnessMin
open fun rasterBrightnessMin(value: Float): PropertyValue
Increase or reduce the brightness of the image. The value is the minimum brightness.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterBrightnessMin(expression: Expression): PropertyValue<Expression>
Increase or reduce the brightness of the image. The value is the minimum brightness.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterContrast
open fun rasterContrast(value: Float): PropertyValue
Increase or reduce the contrast of the image.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterContrast(expression: Expression): PropertyValue<Expression>
Increase or reduce the contrast of the image.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterFadeDuration
open fun rasterFadeDuration(value: Float): PropertyValue
Fade duration when a new tile is added.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterFadeDuration(expression: Expression): PropertyValue<Expression>
Fade duration when a new tile is added.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterHueRotate
open fun rasterHueRotate(value: Float): PropertyValue
Rotates hues around the color wheel.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterHueRotate(expression: Expression): PropertyValue<Expression>
Rotates hues around the color wheel.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterOpacity
open fun rasterOpacity(value: Float): PropertyValue
The opacity at which the image will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterOpacity(expression: Expression): PropertyValue<Expression>
The opacity at which the image will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterResampling
open fun rasterResampling(value: String): PropertyValue
The resampling/interpolation method to use for overscaling, also known as texture magnification filter
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun rasterResampling(expression: Expression): PropertyValue<Expression>
The resampling/interpolation method to use for overscaling, also known as texture magnification filter
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
rasterSaturation
open fun rasterSaturation(value: Float): PropertyValue
Increase or reduce the saturation of the image.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun rasterSaturation(expression: Expression): PropertyValue<Expression>
Increase or reduce the saturation of the image.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
symbolAvoidEdges
open fun symbolAvoidEdges(value: Boolean): PropertyValue
If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don’t have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun symbolAvoidEdges(value: Expression): PropertyValue<Expression>
If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don’t have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
symbolPlacement
open fun symbolPlacement(value: String): PropertyValue
Label placement relative to its geometry.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun symbolPlacement(value: Expression): PropertyValue<Expression>
Label placement relative to its geometry.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
symbolSortKey
open fun symbolSortKey(value: Float): PropertyValue
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When iconAllowOverlap or textAllowOverlap is false
, features with a lower sort key will have priority during placement. When iconAllowOverlap or textAllowOverlap is set to true
, features with a higher sort key will overlap over features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun symbolSortKey(value: Expression): PropertyValue<Expression>
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When iconAllowOverlap or textAllowOverlap is false
, features with a lower sort key will have priority during placement. When iconAllowOverlap or textAllowOverlap is set to true
, features with a higher sort key will overlap over features with a lower sort key.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
symbolSpacing
open fun symbolSpacing(value: Float): PropertyValue
Distance between two symbol anchors.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun symbolSpacing(value: Expression): PropertyValue<Expression>
Distance between two symbol anchors.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
symbolZOrder
open fun symbolZOrder(value: String): PropertyValue
Controls the order in which overlapping symbols in the same layer are rendered
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun symbolZOrder(value: Expression): PropertyValue<Expression>
Controls the order in which overlapping symbols in the same layer are rendered
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
textAllowOverlap
open fun textAllowOverlap(value: Boolean): PropertyValue
If true, the text will be visible even if it collides with other previously drawn symbols.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun textAllowOverlap(value: Expression): PropertyValue<Expression>
If true, the text will be visible even if it collides with other previously drawn symbols.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
textAnchor
open fun textAnchor(value: String): PropertyValue
Part of the text placed closest to the anchor.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textAnchor(value: Expression): PropertyValue<Expression>
Part of the text placed closest to the anchor.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
textColor
open fun textColor(value: Int): PropertyValue
The color with which the text will be drawn.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun textColor(value: String): PropertyValue
The color with which the text will be drawn.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textColor(expression: Expression): PropertyValue<Expression>
The color with which the text will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textField
open fun textField(value: String): PropertyValue
Value to use for a text label. If a plain string
is provided, it will be treated as a formatted
with default/inherited formatting options.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textField(value: Formatted): PropertyValue<Formatted>
Value to use for a text label. If a plain string
is provided, it will be treated as a formatted
with default/inherited formatting options.
Return
property wrapper around Formatted
Parameters
Name | Summary |
---|---|
value | a Formatted value |
open fun textField(value: Expression): PropertyValue<Expression>
Value to use for a text label. If a plain string
is provided, it will be treated as a formatted
with default/inherited formatting options.
Return
property wrapper around Formatted
Parameters
Name | Summary |
---|---|
value | a Formatted value |
textFont
open fun textFont(value: Array
Font stack to use for displaying text.
Return
property wrapper around String[]
Parameters
Name | Summary |
---|---|
value | a String[] value |
open fun textFont(value: Expression): PropertyValue<Expression>
Font stack to use for displaying text.
Return
property wrapper around String[]
Parameters
Name | Summary |
---|---|
value | a String[] value |
textHaloBlur
open fun textHaloBlur(value: Float): PropertyValue
The halo’s fadeout distance towards the outside.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textHaloBlur(expression: Expression): PropertyValue<Expression>
The halo’s fadeout distance towards the outside.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textHaloColor
open fun textHaloColor(value: Int): PropertyValue
The color of the text’s halo, which helps it stand out from backgrounds.
Return
property wrapper around String color
Parameters
Name | Summary |
---|---|
value | a int color value |
open fun textHaloColor(value: String): PropertyValue
The color of the text’s halo, which helps it stand out from backgrounds.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textHaloColor(expression: Expression): PropertyValue<Expression>
The color of the text’s halo, which helps it stand out from backgrounds.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textHaloWidth
open fun textHaloWidth(value: Float): PropertyValue
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textHaloWidth(expression: Expression): PropertyValue<Expression>
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textIgnorePlacement
open fun textIgnorePlacement(value: Boolean): PropertyValue
If true, other symbols can be visible even if they collide with the text.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun textIgnorePlacement(value: Expression): PropertyValue<Expression>
If true, other symbols can be visible even if they collide with the text.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
textJustify
open fun textJustify(value: String): PropertyValue
Text justification options.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textJustify(value: Expression): PropertyValue<Expression>
Text justification options.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
textKeepUpright
open fun textKeepUpright(value: Boolean): PropertyValue
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun textKeepUpright(value: Expression): PropertyValue<Expression>
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
textLetterSpacing
open fun textLetterSpacing(value: Float): PropertyValue
Text tracking amount.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textLetterSpacing(value: Expression): PropertyValue<Expression>
Text tracking amount.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textLineHeight
open fun textLineHeight(value: Float): PropertyValue
Text leading value for multi-line text.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textLineHeight(value: Expression): PropertyValue<Expression>
Text leading value for multi-line text.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textMaxAngle
open fun textMaxAngle(value: Float): PropertyValue
Maximum angle change between adjacent characters.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textMaxAngle(value: Expression): PropertyValue<Expression>
Maximum angle change between adjacent characters.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textMaxWidth
open fun textMaxWidth(value: Float): PropertyValue
The maximum line width for text wrapping.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textMaxWidth(value: Expression): PropertyValue<Expression>
The maximum line width for text wrapping.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textOffset
open fun textOffset(value: Array
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun textOffset(value: Expression): PropertyValue<Expression>
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
textOpacity
open fun textOpacity(value: Float): PropertyValue
The opacity at which the text will be drawn.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textOpacity(expression: Expression): PropertyValue<Expression>
The opacity at which the text will be drawn.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textOptional
open fun textOptional(value: Boolean): PropertyValue
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
open fun textOptional(value: Expression): PropertyValue<Expression>
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
Return
property wrapper around Boolean
Parameters
Name | Summary |
---|---|
value | a Boolean value |
textPadding
open fun textPadding(value: Float): PropertyValue
Size of the additional area around the text bounding box used for detecting symbol collisions.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textPadding(value: Expression): PropertyValue<Expression>
Size of the additional area around the text bounding box used for detecting symbol collisions.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textPitchAlignment
open fun textPitchAlignment(value: String): PropertyValue
Orientation of text when map is pitched.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textPitchAlignment(value: Expression): PropertyValue<Expression>
Orientation of text when map is pitched.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
textRadialOffset
open fun textRadialOffset(value: Float): PropertyValue
Radial offset of text, in the direction of the symbol’s anchor. Useful in combination with textVariableAnchor, which defaults to using the two-dimensional textOffset if present.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textRadialOffset(value: Expression): PropertyValue<Expression>
Radial offset of text, in the direction of the symbol’s anchor. Useful in combination with textVariableAnchor, which defaults to using the two-dimensional textOffset if present.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textRotate
open fun textRotate(value: Float): PropertyValue
Rotates the text clockwise.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textRotate(value: Expression): PropertyValue<Expression>
Rotates the text clockwise.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textRotationAlignment
open fun textRotationAlignment(value: String): PropertyValue
In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of the individual glyphs forming the text.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textRotationAlignment(value: Expression): PropertyValue<Expression>
In combination with Property.SYMBOL_PLACEMENT, determines the rotation behavior of the individual glyphs forming the text.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
textSize
open fun textSize(value: Float): PropertyValue
Font size.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
open fun textSize(value: Expression): PropertyValue<Expression>
Font size.
Return
property wrapper around Float
Parameters
Name | Summary |
---|---|
value | a Float value |
textTransform
open fun textTransform(value: String): PropertyValue
Specifies how to capitalize text, similar to the CSS textTransform property.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textTransform(value: Expression): PropertyValue<Expression>
Specifies how to capitalize text, similar to the CSS textTransform property.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
textTranslateAnchor
open fun textTranslateAnchor(value: String): PropertyValue
Controls the frame of reference for textTranslate.
Return
property wrapper around String
Parameters
Name | Summary |
---|---|
value | a String value |
open fun textTranslateAnchor(expression: Expression): PropertyValue<Expression>
Controls the frame of reference for textTranslate.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textTranslate
open fun textTranslate(value: Array
Distance that the text’s anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
Return
property wrapper around Float[]
Parameters
Name | Summary |
---|---|
value | a Float[] value |
open fun textTranslate(expression: Expression): PropertyValue<Expression>
Distance that the text’s anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
Return
property wrapper around an expression statement
Parameters
Name | Summary |
---|---|
expression | an expression statement |
textVariableAnchor
open fun textVariableAnchor(value: Array
To increase the chance of placing high-priority labels on the map, you can provide an array of Property.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 textRadialOffset or the two-dimensional textOffset.
Return
property wrapper around String[]
Parameters
Name | Summary |
---|---|
value | a String[] value |
open fun textVariableAnchor(value: Expression): PropertyValue<Expression>
To increase the chance of placing high-priority labels on the map, you can provide an array of Property.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 textRadialOffset or the two-dimensional textOffset.
Return
property wrapper around String[]
Parameters
Name | Summary |
---|---|
value | a String[] value |
textWritingMode
open fun textWritingMode(value: Array
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. The order of elements in an array define priority order for the placement of an orientation variant.
Return
property wrapper around String[]
Parameters
Name | Summary |
---|---|
value | a String[] value |
open fun textWritingMode(value: Expression): PropertyValue<Expression>
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. The order of elements in an array define priority order for the placement of an orientation variant.
Return
property wrapper around String[]
Parameters
Name | Summary |
---|---|
value | a String[] value |
visibility
open fun visibility(value: String): PropertyValue
Set the property visibility.
Return
property wrapper around visibility
Parameters
Name | Summary |
---|---|
value | the visibility value |
PropertyValue
open class PropertyValue<T>
Properties for Layer
Constructors
Name | Summary |
---|---|
PropertyValue | open fun PropertyValue(name: String, value: T)Not part of the public API. |
Functions
Name | Summary |
---|---|
equals | open fun equals(o: Any): Boolean |
getColorInt | @Nullable() open fun getColorInt(): Integer Get the color int value of the property if the value is a color. |
getExpression | @Nullable() open fun getExpression(): Expression Get the expression of the property. |
hashCode | open fun hashCode(): Int |
isExpression | open fun isExpression(): Boolean Returns if this is a expression. |
isNull | open fun isNull(): Boolean Returns if this is null |
isValue | open fun isValue(): Boolean Returns if this is a value. |
toString | open fun toString(): String Get the string representation of a property value. |
Properties
Name | Summary |
---|---|
name | @NonNull() val name: String |
value | val value: T |
Inheritors
Name |
---|
LayoutPropertyValue |
PaintPropertyValue |
equals
open fun equals(o: Any): Boolean
getColorInt
@Nullable()
open fun getColorInt(): Integer
Get the color int value of the property if the value is a color.
Return
the color int value of the property, null if not a color value
getExpression
@Nullable()
open fun getExpression(): Expression
Get the expression of the property.
Return
the property expression
hashCode
open fun hashCode(): Int
isExpression
open fun isExpression(): Boolean
Returns if this is a expression.
Return
true if this is a expression, false if not
isNull
open fun isNull(): Boolean
Returns if this is null
Return
true if this is null, false if not
isValue
open fun isValue(): Boolean
Returns if this is a value.
Return
true if is a value, false if not
name
@NonNull()
val name: String
toString
open fun toString(): String
Get the string representation of a property value.
Return
the string representation
value
RasterLayer
@UiThread()
open class RasterLayer : Layer
Raster map textures such as satellite imagery.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
RasterLayer | open fun RasterLayer(nativePtr: Long)Creates a RasterLayer. |
RasterLayer | open fun RasterLayer(layerId: String, sourceId: String)Creates a RasterLayer. |
Functions
Name | Summary |
---|---|
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getRasterBrightnessMax | @NonNull() open fun getRasterBrightnessMax(): PropertyValue Get the RasterBrightnessMax property |
getRasterBrightnessMaxTransition | @NonNull() open fun getRasterBrightnessMaxTransition(): TransitionOptions Get the RasterBrightnessMax property transition options |
getRasterBrightnessMin | @NonNull() open fun getRasterBrightnessMin(): PropertyValue Get the RasterBrightnessMin property |
getRasterBrightnessMinTransition | @NonNull() open fun getRasterBrightnessMinTransition(): TransitionOptions Get the RasterBrightnessMin property transition options |
getRasterContrast | @NonNull() open fun getRasterContrast(): PropertyValue Get the RasterContrast property |
getRasterContrastTransition | @NonNull() open fun getRasterContrastTransition(): TransitionOptions Get the RasterContrast property transition options |
getRasterFadeDuration | @NonNull() open fun getRasterFadeDuration(): PropertyValue Get the RasterFadeDuration property |
getRasterHueRotate | @NonNull() open fun getRasterHueRotate(): PropertyValue Get the RasterHueRotate property |
getRasterHueRotateTransition | @NonNull() open fun getRasterHueRotateTransition(): TransitionOptions Get the RasterHueRotate property transition options |
getRasterOpacity | @NonNull() open fun getRasterOpacity(): PropertyValue Get the RasterOpacity property |
getRasterOpacityTransition | @NonNull() open fun getRasterOpacityTransition(): TransitionOptions Get the RasterOpacity property transition options |
getRasterResampling | @NonNull() open fun getRasterResampling(): PropertyValue Get the RasterResampling property |
getRasterSaturation | @NonNull() open fun getRasterSaturation(): PropertyValue Get the RasterSaturation property |
getRasterSaturationTransition | @NonNull() open fun getRasterSaturationTransition(): TransitionOptions Get the RasterSaturation property transition options |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setRasterBrightnessMaxTransition | open fun setRasterBrightnessMaxTransition(options: TransitionOptions) Set the RasterBrightnessMax property transition options |
setRasterBrightnessMinTransition | open fun setRasterBrightnessMinTransition(options: TransitionOptions) Set the RasterBrightnessMin property transition options |
setRasterContrastTransition | open fun setRasterContrastTransition(options: TransitionOptions) Set the RasterContrast property transition options |
setRasterHueRotateTransition | open fun setRasterHueRotateTransition(options: TransitionOptions) Set the RasterHueRotate property transition options |
setRasterOpacityTransition | open fun setRasterOpacityTransition(options: TransitionOptions) Set the RasterOpacity property transition options |
setRasterSaturationTransition | open fun setRasterSaturationTransition(options: TransitionOptions) Set the RasterSaturation property transition options |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): RasterLayer Set the source Layer. |
getRasterBrightnessMaxTransition
@NonNull()
open fun getRasterBrightnessMaxTransition(): TransitionOptions
Get the RasterBrightnessMax property transition options
Return
transition options for Float
getRasterBrightnessMax
@NonNull()
open fun getRasterBrightnessMax(): PropertyValue
Get the RasterBrightnessMax property
Return
property wrapper value around Float
getRasterBrightnessMinTransition
@NonNull()
open fun getRasterBrightnessMinTransition(): TransitionOptions
Get the RasterBrightnessMin property transition options
Return
transition options for Float
getRasterBrightnessMin
@NonNull()
open fun getRasterBrightnessMin(): PropertyValue
Get the RasterBrightnessMin property
Return
property wrapper value around Float
getRasterContrastTransition
@NonNull()
open fun getRasterContrastTransition(): TransitionOptions
Get the RasterContrast property transition options
Return
transition options for Float
getRasterContrast
@NonNull()
open fun getRasterContrast(): PropertyValue
Get the RasterContrast property
Return
property wrapper value around Float
getRasterFadeDuration
@NonNull()
open fun getRasterFadeDuration(): PropertyValue
Get the RasterFadeDuration property
Return
property wrapper value around Float
getRasterHueRotateTransition
@NonNull()
open fun getRasterHueRotateTransition(): TransitionOptions
Get the RasterHueRotate property transition options
Return
transition options for Float
getRasterHueRotate
@NonNull()
open fun getRasterHueRotate(): PropertyValue
Get the RasterHueRotate property
Return
property wrapper value around Float
getRasterOpacityTransition
@NonNull()
open fun getRasterOpacityTransition(): TransitionOptions
Get the RasterOpacity property transition options
Return
transition options for Float
getRasterOpacity
@NonNull()
open fun getRasterOpacity(): PropertyValue
Get the RasterOpacity property
Return
property wrapper value around Float
getRasterResampling
@NonNull()
open fun getRasterResampling(): PropertyValue
Get the RasterResampling property
Return
property wrapper value around String
getRasterSaturationTransition
@NonNull()
open fun getRasterSaturationTransition(): TransitionOptions
Get the RasterSaturation property transition options
Return
transition options for Float
getRasterSaturation
@NonNull()
open fun getRasterSaturation(): PropertyValue
Get the RasterSaturation property
Return
property wrapper value around Float
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
setRasterBrightnessMaxTransition
open fun setRasterBrightnessMaxTransition(options: TransitionOptions)
Set the RasterBrightnessMax property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setRasterBrightnessMinTransition
open fun setRasterBrightnessMinTransition(options: TransitionOptions)
Set the RasterBrightnessMin property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setRasterContrastTransition
open fun setRasterContrastTransition(options: TransitionOptions)
Set the RasterContrast property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setRasterHueRotateTransition
open fun setRasterHueRotateTransition(options: TransitionOptions)
Set the RasterHueRotate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setRasterOpacityTransition
open fun setRasterOpacityTransition(options: TransitionOptions)
Set the RasterOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setRasterSaturationTransition
open fun setRasterSaturationTransition(options: TransitionOptions)
Set the RasterSaturation property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): RasterLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
SymbolLayer
@UiThread()
open class SymbolLayer : Layer
An icon or a text label.
See also
Name | Summary |
---|---|
The online documentation | The online documentation |
Constructors
Name | Summary |
---|---|
SymbolLayer | open fun SymbolLayer(nativePtr: Long)Creates a SymbolLayer. |
SymbolLayer | open fun SymbolLayer(layerId: String, sourceId: String)Creates a SymbolLayer. |
Functions
Name | Summary |
---|---|
getFilter | @Nullable() open fun getFilter(): Expression Get a single expression filter. |
getIconAllowOverlap | @NonNull() open fun getIconAllowOverlap(): PropertyValue Get the IconAllowOverlap property |
getIconAnchor | @NonNull() open fun getIconAnchor(): PropertyValue Get the IconAnchor property |
getIconColor | @NonNull() open fun getIconColor(): PropertyValue Get the IconColor property |
getIconColorAsInt | open fun getIconColorAsInt(): Int The color of the icon. |
getIconColorTransition | @NonNull() open fun getIconColorTransition(): TransitionOptions Get the IconColor property transition options |
getIconHaloBlur | @NonNull() open fun getIconHaloBlur(): PropertyValue Get the IconHaloBlur property |
getIconHaloBlurTransition | @NonNull() open fun getIconHaloBlurTransition(): TransitionOptions Get the IconHaloBlur property transition options |
getIconHaloColor | @NonNull() open fun getIconHaloColor(): PropertyValue Get the IconHaloColor property |
getIconHaloColorAsInt | open fun getIconHaloColorAsInt(): Int The color of the icon’s halo. |
getIconHaloColorTransition | @NonNull() open fun getIconHaloColorTransition(): TransitionOptions Get the IconHaloColor property transition options |
getIconHaloWidth | @NonNull() open fun getIconHaloWidth(): PropertyValue Get the IconHaloWidth property |
getIconHaloWidthTransition | @NonNull() open fun getIconHaloWidthTransition(): TransitionOptions Get the IconHaloWidth property transition options |
getIconIgnorePlacement | @NonNull() open fun getIconIgnorePlacement(): PropertyValue Get the IconIgnorePlacement property |
getIconImage | @NonNull() open fun getIconImage(): PropertyValue Get the IconImage property |
getIconKeepUpright | @NonNull() open fun getIconKeepUpright(): PropertyValue Get the IconKeepUpright property |
getIconOffset | @NonNull() open fun getIconOffset(): PropertyValue<Array Get the IconOffset property |
getIconOpacity | @NonNull() open fun getIconOpacity(): PropertyValue Get the IconOpacity property |
getIconOpacityTransition | @NonNull() open fun getIconOpacityTransition(): TransitionOptions Get the IconOpacity property transition options |
getIconOptional | @NonNull() open fun getIconOptional(): PropertyValue Get the IconOptional property |
getIconPadding | @NonNull() open fun getIconPadding(): PropertyValue Get the IconPadding property |
getIconPitchAlignment | @NonNull() open fun getIconPitchAlignment(): PropertyValue Get the IconPitchAlignment property |
getIconRotate | @NonNull() open fun getIconRotate(): PropertyValue Get the IconRotate property |
getIconRotationAlignment | @NonNull() open fun getIconRotationAlignment(): PropertyValue Get the IconRotationAlignment property |
getIconSize | @NonNull() open fun getIconSize(): PropertyValue Get the IconSize property |
getIconTextFit | @NonNull() open fun getIconTextFit(): PropertyValue Get the IconTextFit property |
getIconTextFitPadding | @NonNull() open fun getIconTextFitPadding(): PropertyValue<Array Get the IconTextFitPadding property |
getIconTranslate | @NonNull() open fun getIconTranslate(): PropertyValue<Array Get the IconTranslate property |
getIconTranslateAnchor | @NonNull() open fun getIconTranslateAnchor(): PropertyValue Get the IconTranslateAnchor property |
getIconTranslateTransition | @NonNull() open fun getIconTranslateTransition(): TransitionOptions Get the IconTranslate property transition options |
getId | @NonNull() open fun getId(): String |
getMaxZoom | open fun getMaxZoom(): Float |
getMinZoom | open fun getMinZoom(): Float |
getNativePtr | open fun getNativePtr(): Long |
getSourceId | @NonNull() open fun getSourceId(): String Get the source id. |
getSourceLayer | @NonNull() open fun getSourceLayer(): String Get the source layer. |
getSymbolAvoidEdges | @NonNull() open fun getSymbolAvoidEdges(): PropertyValue Get the SymbolAvoidEdges property |
getSymbolPlacement | @NonNull() open fun getSymbolPlacement(): PropertyValue Get the SymbolPlacement property |
getSymbolSortKey | @NonNull() open fun getSymbolSortKey(): PropertyValue Get the SymbolSortKey property |
getSymbolSpacing | @NonNull() open fun getSymbolSpacing(): PropertyValue Get the SymbolSpacing property |
getSymbolZOrder | @NonNull() open fun getSymbolZOrder(): PropertyValue Get the SymbolZOrder property |
getTextAllowOverlap | @NonNull() open fun getTextAllowOverlap(): PropertyValue Get the TextAllowOverlap property |
getTextAnchor | @NonNull() open fun getTextAnchor(): PropertyValue Get the TextAnchor property |
getTextColor | @NonNull() open fun getTextColor(): PropertyValue Get the TextColor property |
getTextColorAsInt | open fun getTextColorAsInt(): Int The color with which the text will be drawn. |
getTextColorTransition | @NonNull() open fun getTextColorTransition(): TransitionOptions Get the TextColor property transition options |
getTextField | @NonNull() open fun getTextField(): PropertyValue<Formatted> Get the TextField property |
getTextFont | @NonNull() open fun getTextFont(): PropertyValue<Array Get the TextFont property |
getTextHaloBlur | @NonNull() open fun getTextHaloBlur(): PropertyValue Get the TextHaloBlur property |
getTextHaloBlurTransition | @NonNull() open fun getTextHaloBlurTransition(): TransitionOptions Get the TextHaloBlur property transition options |
getTextHaloColor | @NonNull() open fun getTextHaloColor(): PropertyValue Get the TextHaloColor property |
getTextHaloColorAsInt | open fun getTextHaloColorAsInt(): Int The color of the text’s halo, which helps it stand out from backgrounds. |
getTextHaloColorTransition | @NonNull() open fun getTextHaloColorTransition(): TransitionOptions Get the TextHaloColor property transition options |
getTextHaloWidth | @NonNull() open fun getTextHaloWidth(): PropertyValue Get the TextHaloWidth property |
getTextHaloWidthTransition | @NonNull() open fun getTextHaloWidthTransition(): TransitionOptions Get the TextHaloWidth property transition options |
getTextIgnorePlacement | @NonNull() open fun getTextIgnorePlacement(): PropertyValue Get the TextIgnorePlacement property |
getTextJustify | @NonNull() open fun getTextJustify(): PropertyValue Get the TextJustify property |
getTextKeepUpright | @NonNull() open fun getTextKeepUpright(): PropertyValue Get the TextKeepUpright property |
getTextLetterSpacing | @NonNull() open fun getTextLetterSpacing(): PropertyValue Get the TextLetterSpacing property |
getTextLineHeight | @NonNull() open fun getTextLineHeight(): PropertyValue Get the TextLineHeight property |
getTextMaxAngle | @NonNull() open fun getTextMaxAngle(): PropertyValue Get the TextMaxAngle property |
getTextMaxWidth | @NonNull() open fun getTextMaxWidth(): PropertyValue Get the TextMaxWidth property |
getTextOffset | @NonNull() open fun getTextOffset(): PropertyValue<Array Get the TextOffset property |
getTextOpacity | @NonNull() open fun getTextOpacity(): PropertyValue Get the TextOpacity property |
getTextOpacityTransition | @NonNull() open fun getTextOpacityTransition(): TransitionOptions Get the TextOpacity property transition options |
getTextOptional | @NonNull() open fun getTextOptional(): PropertyValue Get the TextOptional property |
getTextPadding | @NonNull() open fun getTextPadding(): PropertyValue Get the TextPadding property |
getTextPitchAlignment | @NonNull() open fun getTextPitchAlignment(): PropertyValue Get the TextPitchAlignment property |
getTextRadialOffset | @NonNull() open fun getTextRadialOffset(): PropertyValue Get the TextRadialOffset property |
getTextRotate | @NonNull() open fun getTextRotate(): PropertyValue Get the TextRotate property |
getTextRotationAlignment | @NonNull() open fun getTextRotationAlignment(): PropertyValue Get the TextRotationAlignment property |
getTextSize | @NonNull() open fun getTextSize(): PropertyValue Get the TextSize property |
getTextTransform | @NonNull() open fun getTextTransform(): PropertyValue Get the TextTransform property |
getTextTranslate | @NonNull() open fun getTextTranslate(): PropertyValue<Array Get the TextTranslate property |
getTextTranslateAnchor | @NonNull() open fun getTextTranslateAnchor(): PropertyValue Get the TextTranslateAnchor property |
getTextTranslateTransition | @NonNull() open fun getTextTranslateTransition(): TransitionOptions Get the TextTranslate property transition options |
getTextVariableAnchor | @NonNull() open fun getTextVariableAnchor(): PropertyValue<Array Get the TextVariableAnchor property |
getTextWritingMode | @NonNull() open fun getTextWritingMode(): PropertyValue<Array Get the TextWritingMode property |
getVisibility | @NonNull() open fun getVisibility(): PropertyValue |
isDetached | open fun isDetached(): Boolean |
setDetached | open fun setDetached() |
setFilter | open fun setFilter(filter: Expression) Set a single expression filter. |
setIconColorTransition | open fun setIconColorTransition(options: TransitionOptions) Set the IconColor property transition options |
setIconHaloBlurTransition | open fun setIconHaloBlurTransition(options: TransitionOptions) Set the IconHaloBlur property transition options |
setIconHaloColorTransition | open fun setIconHaloColorTransition(options: TransitionOptions) Set the IconHaloColor property transition options |
setIconHaloWidthTransition | open fun setIconHaloWidthTransition(options: TransitionOptions) Set the IconHaloWidth property transition options |
setIconOpacityTransition | open fun setIconOpacityTransition(options: TransitionOptions) Set the IconOpacity property transition options |
setIconTranslateTransition | open fun setIconTranslateTransition(options: TransitionOptions) Set the IconTranslate property transition options |
setMaxZoom | open fun setMaxZoom(zoom: Float) |
setMinZoom | open fun setMinZoom(zoom: Float) |
setProperties | open fun setProperties(properties: Array<PropertyValue |
setSourceLayer | open fun setSourceLayer(sourceLayer: String) Set the source layer. |
setTextColorTransition | open fun setTextColorTransition(options: TransitionOptions) Set the TextColor property transition options |
setTextHaloBlurTransition | open fun setTextHaloBlurTransition(options: TransitionOptions) Set the TextHaloBlur property transition options |
setTextHaloColorTransition | open fun setTextHaloColorTransition(options: TransitionOptions) Set the TextHaloColor property transition options |
setTextHaloWidthTransition | open fun setTextHaloWidthTransition(options: TransitionOptions) Set the TextHaloWidth property transition options |
setTextOpacityTransition | open fun setTextOpacityTransition(options: TransitionOptions) Set the TextOpacity property transition options |
setTextTranslateTransition | open fun setTextTranslateTransition(options: TransitionOptions) Set the TextTranslate property transition options |
withFilter | @NonNull() open fun withFilter(filter: Expression): SymbolLayer Set a single expression filter. |
withProperties | @NonNull() open fun withProperties(properties: Array<PropertyValue Set a property or properties. |
withSourceLayer | @NonNull() open fun withSourceLayer(sourceLayer: String): SymbolLayer Set the source Layer. |
getFilter
@Nullable()
open fun getFilter(): Expression
Get a single expression filter.
Return
the expression filter to get
getIconAllowOverlap
@NonNull()
open fun getIconAllowOverlap(): PropertyValue
Get the IconAllowOverlap property
Return
property wrapper value around Boolean
getIconAnchor
@NonNull()
open fun getIconAnchor(): PropertyValue
Get the IconAnchor property
Return
property wrapper value around String
getIconColorAsInt
open fun getIconColorAsInt(): Int
The color of the icon. This can only be used with sdf icons.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getIconColorTransition
@NonNull()
open fun getIconColorTransition(): TransitionOptions
Get the IconColor property transition options
Return
transition options for String
getIconColor
@NonNull()
open fun getIconColor(): PropertyValue
Get the IconColor property
Return
property wrapper value around String
getIconHaloBlurTransition
@NonNull()
open fun getIconHaloBlurTransition(): TransitionOptions
Get the IconHaloBlur property transition options
Return
transition options for Float
getIconHaloBlur
@NonNull()
open fun getIconHaloBlur(): PropertyValue
Get the IconHaloBlur property
Return
property wrapper value around Float
getIconHaloColorAsInt
open fun getIconHaloColorAsInt(): Int
The color of the icon’s halo. Icon halos can only be used with SDF icons.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getIconHaloColorTransition
@NonNull()
open fun getIconHaloColorTransition(): TransitionOptions
Get the IconHaloColor property transition options
Return
transition options for String
getIconHaloColor
@NonNull()
open fun getIconHaloColor(): PropertyValue
Get the IconHaloColor property
Return
property wrapper value around String
getIconHaloWidthTransition
@NonNull()
open fun getIconHaloWidthTransition(): TransitionOptions
Get the IconHaloWidth property transition options
Return
transition options for Float
getIconHaloWidth
@NonNull()
open fun getIconHaloWidth(): PropertyValue
Get the IconHaloWidth property
Return
property wrapper value around Float
getIconIgnorePlacement
@NonNull()
open fun getIconIgnorePlacement(): PropertyValue
Get the IconIgnorePlacement property
Return
property wrapper value around Boolean
getIconImage
@NonNull()
open fun getIconImage(): PropertyValue
Get the IconImage property
Return
property wrapper value around String
getIconKeepUpright
@NonNull()
open fun getIconKeepUpright(): PropertyValue
Get the IconKeepUpright property
Return
property wrapper value around Boolean
getIconOffset
@NonNull()
open fun getIconOffset(): PropertyValue<Array
Get the IconOffset property
Return
property wrapper value around Float[]
getIconOpacityTransition
@NonNull()
open fun getIconOpacityTransition(): TransitionOptions
Get the IconOpacity property transition options
Return
transition options for Float
getIconOpacity
@NonNull()
open fun getIconOpacity(): PropertyValue
Get the IconOpacity property
Return
property wrapper value around Float
getIconOptional
@NonNull()
open fun getIconOptional(): PropertyValue
Get the IconOptional property
Return
property wrapper value around Boolean
getIconPadding
@NonNull()
open fun getIconPadding(): PropertyValue
Get the IconPadding property
Return
property wrapper value around Float
getIconPitchAlignment
@NonNull()
open fun getIconPitchAlignment(): PropertyValue
Get the IconPitchAlignment property
Return
property wrapper value around String
getIconRotate
@NonNull()
open fun getIconRotate(): PropertyValue
Get the IconRotate property
Return
property wrapper value around Float
getIconRotationAlignment
@NonNull()
open fun getIconRotationAlignment(): PropertyValue
Get the IconRotationAlignment property
Return
property wrapper value around String
getIconSize
@NonNull()
open fun getIconSize(): PropertyValue
Get the IconSize property
Return
property wrapper value around Float
getIconTextFitPadding
@NonNull()
open fun getIconTextFitPadding(): PropertyValue<Array
Get the IconTextFitPadding property
Return
property wrapper value around Float[]
getIconTextFit
@NonNull()
open fun getIconTextFit(): PropertyValue
Get the IconTextFit property
Return
property wrapper value around String
getIconTranslateAnchor
@NonNull()
open fun getIconTranslateAnchor(): PropertyValue
Get the IconTranslateAnchor property
Return
property wrapper value around String
getIconTranslateTransition
@NonNull()
open fun getIconTranslateTransition(): TransitionOptions
Get the IconTranslate property transition options
Return
transition options for Float[]
getIconTranslate
@NonNull()
open fun getIconTranslate(): PropertyValue<Array
Get the IconTranslate property
Return
property wrapper value around Float[]
getSourceId
@NonNull()
open fun getSourceId(): String
Get the source id.
Return
id of the source
getSourceLayer
@NonNull()
open fun getSourceLayer(): String
Get the source layer.
Return
sourceLayer the source layer to get
getSymbolAvoidEdges
@NonNull()
open fun getSymbolAvoidEdges(): PropertyValue
Get the SymbolAvoidEdges property
Return
property wrapper value around Boolean
getSymbolPlacement
@NonNull()
open fun getSymbolPlacement(): PropertyValue
Get the SymbolPlacement property
Return
property wrapper value around String
getSymbolSortKey
@NonNull()
open fun getSymbolSortKey(): PropertyValue
Get the SymbolSortKey property
Return
property wrapper value around Float
getSymbolSpacing
@NonNull()
open fun getSymbolSpacing(): PropertyValue
Get the SymbolSpacing property
Return
property wrapper value around Float
getSymbolZOrder
@NonNull()
open fun getSymbolZOrder(): PropertyValue
Get the SymbolZOrder property
Return
property wrapper value around String
getTextAllowOverlap
@NonNull()
open fun getTextAllowOverlap(): PropertyValue
Get the TextAllowOverlap property
Return
property wrapper value around Boolean
getTextAnchor
@NonNull()
open fun getTextAnchor(): PropertyValue
Get the TextAnchor property
Return
property wrapper value around String
getTextColorAsInt
open fun getTextColorAsInt(): Int
The color with which the text will be drawn.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getTextColorTransition
@NonNull()
open fun getTextColorTransition(): TransitionOptions
Get the TextColor property transition options
Return
transition options for String
getTextColor
@NonNull()
open fun getTextColor(): PropertyValue
Get the TextColor property
Return
property wrapper value around String
getTextField
@NonNull()
open fun getTextField(): PropertyValue<Formatted>
Get the TextField property
Return
property wrapper value around Formatted
getTextFont
@NonNull()
open fun getTextFont(): PropertyValue<Array
Get the TextFont property
Return
property wrapper value around String[]
getTextHaloBlurTransition
@NonNull()
open fun getTextHaloBlurTransition(): TransitionOptions
Get the TextHaloBlur property transition options
Return
transition options for Float
getTextHaloBlur
@NonNull()
open fun getTextHaloBlur(): PropertyValue
Get the TextHaloBlur property
Return
property wrapper value around Float
getTextHaloColorAsInt
open fun getTextHaloColorAsInt(): Int
The color of the text’s halo, which helps it stand out from backgrounds.
Return
int representation of a rgba string color
Throws
Name | Summary |
---|---|
java.lang.RuntimeException | thrown if property isn’t a value |
getTextHaloColorTransition
@NonNull()
open fun getTextHaloColorTransition(): TransitionOptions
Get the TextHaloColor property transition options
Return
transition options for String
getTextHaloColor
@NonNull()
open fun getTextHaloColor(): PropertyValue
Get the TextHaloColor property
Return
property wrapper value around String
getTextHaloWidthTransition
@NonNull()
open fun getTextHaloWidthTransition(): TransitionOptions
Get the TextHaloWidth property transition options
Return
transition options for Float
getTextHaloWidth
@NonNull()
open fun getTextHaloWidth(): PropertyValue
Get the TextHaloWidth property
Return
property wrapper value around Float
getTextIgnorePlacement
@NonNull()
open fun getTextIgnorePlacement(): PropertyValue
Get the TextIgnorePlacement property
Return
property wrapper value around Boolean
getTextJustify
@NonNull()
open fun getTextJustify(): PropertyValue
Get the TextJustify property
Return
property wrapper value around String
getTextKeepUpright
@NonNull()
open fun getTextKeepUpright(): PropertyValue
Get the TextKeepUpright property
Return
property wrapper value around Boolean
getTextLetterSpacing
@NonNull()
open fun getTextLetterSpacing(): PropertyValue
Get the TextLetterSpacing property
Return
property wrapper value around Float
getTextLineHeight
@NonNull()
open fun getTextLineHeight(): PropertyValue
Get the TextLineHeight property
Return
property wrapper value around Float
getTextMaxAngle
@NonNull()
open fun getTextMaxAngle(): PropertyValue
Get the TextMaxAngle property
Return
property wrapper value around Float
getTextMaxWidth
@NonNull()
open fun getTextMaxWidth(): PropertyValue
Get the TextMaxWidth property
Return
property wrapper value around Float
getTextOffset
@NonNull()
open fun getTextOffset(): PropertyValue<Array
Get the TextOffset property
Return
property wrapper value around Float[]
getTextOpacityTransition
@NonNull()
open fun getTextOpacityTransition(): TransitionOptions
Get the TextOpacity property transition options
Return
transition options for Float
getTextOpacity
@NonNull()
open fun getTextOpacity(): PropertyValue
Get the TextOpacity property
Return
property wrapper value around Float
getTextOptional
@NonNull()
open fun getTextOptional(): PropertyValue
Get the TextOptional property
Return
property wrapper value around Boolean
getTextPadding
@NonNull()
open fun getTextPadding(): PropertyValue
Get the TextPadding property
Return
property wrapper value around Float
getTextPitchAlignment
@NonNull()
open fun getTextPitchAlignment(): PropertyValue
Get the TextPitchAlignment property
Return
property wrapper value around String
getTextRadialOffset
@NonNull()
open fun getTextRadialOffset(): PropertyValue
Get the TextRadialOffset property
Return
property wrapper value around Float
getTextRotate
@NonNull()
open fun getTextRotate(): PropertyValue
Get the TextRotate property
Return
property wrapper value around Float
getTextRotationAlignment
@NonNull()
open fun getTextRotationAlignment(): PropertyValue
Get the TextRotationAlignment property
Return
property wrapper value around String
getTextSize
@NonNull()
open fun getTextSize(): PropertyValue
Get the TextSize property
Return
property wrapper value around Float
getTextTransform
@NonNull()
open fun getTextTransform(): PropertyValue
Get the TextTransform property
Return
property wrapper value around String
getTextTranslateAnchor
@NonNull()
open fun getTextTranslateAnchor(): PropertyValue
Get the TextTranslateAnchor property
Return
property wrapper value around String
getTextTranslateTransition
@NonNull()
open fun getTextTranslateTransition(): TransitionOptions
Get the TextTranslate property transition options
Return
transition options for Float[]
getTextTranslate
@NonNull()
open fun getTextTranslate(): PropertyValue<Array
Get the TextTranslate property
Return
property wrapper value around Float[]
getTextVariableAnchor
@NonNull()
open fun getTextVariableAnchor(): PropertyValue<Array
Get the TextVariableAnchor property
Return
property wrapper value around String[]
getTextWritingMode
@NonNull()
open fun getTextWritingMode(): PropertyValue<Array
Get the TextWritingMode property
Return
property wrapper value around String[]
setFilter
open fun setFilter(filter: Expression)
Set a single expression filter.
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
setIconColorTransition
open fun setIconColorTransition(options: TransitionOptions)
Set the IconColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setIconHaloBlurTransition
open fun setIconHaloBlurTransition(options: TransitionOptions)
Set the IconHaloBlur property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setIconHaloColorTransition
open fun setIconHaloColorTransition(options: TransitionOptions)
Set the IconHaloColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setIconHaloWidthTransition
open fun setIconHaloWidthTransition(options: TransitionOptions)
Set the IconHaloWidth property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setIconOpacityTransition
open fun setIconOpacityTransition(options: TransitionOptions)
Set the IconOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setIconTranslateTransition
open fun setIconTranslateTransition(options: TransitionOptions)
Set the IconTranslate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
setSourceLayer
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
setTextColorTransition
open fun setTextColorTransition(options: TransitionOptions)
Set the TextColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setTextHaloBlurTransition
open fun setTextHaloBlurTransition(options: TransitionOptions)
Set the TextHaloBlur property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setTextHaloColorTransition
open fun setTextHaloColorTransition(options: TransitionOptions)
Set the TextHaloColor property transition options
Parameters
Name | Summary |
---|---|
options | transition options for String |
setTextHaloWidthTransition
open fun setTextHaloWidthTransition(options: TransitionOptions)
Set the TextHaloWidth property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setTextOpacityTransition
open fun setTextOpacityTransition(options: TransitionOptions)
Set the TextOpacity property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float |
setTextTranslateTransition
open fun setTextTranslateTransition(options: TransitionOptions)
Set the TextTranslate property transition options
Parameters
Name | Summary |
---|---|
options | transition options for Float[] |
withFilter
@NonNull()
open fun withFilter(filter: Expression): SymbolLayer
Set a single expression filter.
Return
This
Parameters
Name | Summary |
---|---|
filter | the expression filter to set |
withProperties
@NonNull()
open fun withProperties(properties: Array<PropertyValue
Set a property or properties.
Return
This
Parameters
Name | Summary |
---|---|
properties | the var-args properties |
withSourceLayer
@NonNull()
open fun withSourceLayer(sourceLayer: String): SymbolLayer
Set the source Layer.
Return
This
Parameters
Name | Summary |
---|---|
sourceLayer | the source layer to set |
TransitionOptions
open class TransitionOptions
Resembles transition property from the style specification.
See also
Name | Summary |
---|---|
Transition documentation | Transition documentation |
Constructors
Name | Summary |
---|---|
TransitionOptions | open fun TransitionOptions(duration: Long, delay: Long)Create a transition property based on duration and a delay. |
TransitionOptions | open fun TransitionOptions(duration: Long, delay: Long, enablePlacementTransitions: Boolean)Create a transition property. |
Functions
Name | Summary |
---|---|
equals | open fun equals(o: Any): Boolean |
fromTransitionOptions | open fun fromTransitionOptions(duration: Long, delay: Long, enablePlacementTransitions: Boolean): TransitionOptions Create a transition property. |
hashCode | open fun hashCode(): Int |
isEnablePlacementTransitions | open fun isEnablePlacementTransitions(): Boolean Get the flag that describes whether the fade in/out symbol placement transition should be enabled. |
toString | open fun toString(): String |
Properties
Name | Summary |
---|---|
delay | private open val delay: Long |
duration | private open val duration: Long |
delay
private open val delay: Long
duration
private open val duration: Long
equals
open fun equals(o: Any): Boolean
fromTransitionOptions
open fun fromTransitionOptions(duration: Long, delay: Long, enablePlacementTransitions: Boolean): TransitionOptions
Create a transition property.
Return
a new transition property object
Parameters
Name | Summary |
---|---|
duration | the duration of the transition |
delay | the delay to start the transition |
enablePlacementTransitions | the flag that describes whether the fade in/out symbol placement transitionshould be enabled. Defaults to true. |
hashCode
open fun hashCode(): Int
isEnablePlacementTransitions
open fun isEnablePlacementTransitions(): Boolean
Get the flag that describes whether the fade in/out symbol placement transition should be enabled.
Return
true if the fade in/out symbol placement transition should be enabled, false otherwise
toString
open fun toString(): String
Android SDK
API Reference
- Root
- attribution
- camera
- constants
- exceptions
- geometry
- http
- location
- location.engine
- location.modes
- location.permissions
- log
- maps
- maps.renderer
- maps.renderer.egl
- maps.renderer.glsurfaceview
- maps.renderer.textureview
- maps.widgets
- module.http
- module.loader
- net
- offline
- snapshotter
- storage
- style.expressions
- style.layers
- style.light
- style.sources
- style.types
- text
- utils