MapLibre Native Android/org.maplibre.android.style.layers/SymbolLayer

SymbolLayer

@UiThread
open class SymbolLayer : Layer

An icon or a text label.

See also

<a href="https://maplibre.org/maplibre-style-spec/#layers-symbol">The online documentation</a>

Constructors

Link copied to clipboard
constructor(layerId: String, sourceId: String)
Creates a SymbolLayer.

Properties

Link copied to clipboard
open val nativePtr: Long

Functions

Link copied to clipboard
@Nullable
open fun getFilter(): Expression
Get a single expression filter.
Link copied to clipboard
@NonNull
open fun getIconAllowOverlap(): PropertyValue<Boolean>
Get the IconAllowOverlap property
Link copied to clipboard
@NonNull
open fun getIconAnchor(): PropertyValue<String>
Get the IconAnchor property
Link copied to clipboard
@NonNull
open fun getIconColor(): PropertyValue<String>
Get the IconColor property
Link copied to clipboard
@ColorInt
open fun getIconColorAsInt(): Int
The color of the icon.
Link copied to clipboard
@NonNull
open fun getIconColorTransition(): TransitionOptions
Get the IconColor property transition options
Link copied to clipboard
@NonNull
open fun getIconHaloBlur(): PropertyValue<Float>
Get the IconHaloBlur property
Link copied to clipboard
@NonNull
open fun getIconHaloBlurTransition(): TransitionOptions
Get the IconHaloBlur property transition options
Link copied to clipboard
@NonNull
open fun getIconHaloColor(): PropertyValue<String>
Get the IconHaloColor property
Link copied to clipboard
@ColorInt
open fun getIconHaloColorAsInt(): Int
The color of the icon's halo.
Link copied to clipboard
@NonNull
open fun getIconHaloColorTransition(): TransitionOptions
Get the IconHaloColor property transition options
Link copied to clipboard
@NonNull
open fun getIconHaloWidth(): PropertyValue<Float>
Get the IconHaloWidth property
Link copied to clipboard
@NonNull
open fun getIconHaloWidthTransition(): TransitionOptions
Get the IconHaloWidth property transition options
Link copied to clipboard
@NonNull
open fun getIconIgnorePlacement(): PropertyValue<Boolean>
Get the IconIgnorePlacement property
Link copied to clipboard
@NonNull
open fun getIconImage(): PropertyValue<String>
Get the IconImage property
Link copied to clipboard
@NonNull
open fun getIconKeepUpright(): PropertyValue<Boolean>
Get the IconKeepUpright property
Link copied to clipboard
@NonNull
open fun getIconOffset(): PropertyValue<Array<Float>>
Get the IconOffset property
Link copied to clipboard
@NonNull
open fun getIconOpacity(): PropertyValue<Float>
Get the IconOpacity property
Link copied to clipboard
@NonNull
open fun getIconOpacityTransition(): TransitionOptions
Get the IconOpacity property transition options
Link copied to clipboard
@NonNull
open fun getIconOptional(): PropertyValue<Boolean>
Get the IconOptional property
Link copied to clipboard
@NonNull
open fun getIconPadding(): PropertyValue<Array<Float>>
Get the IconPadding property
Link copied to clipboard
@NonNull
open fun getIconPitchAlignment(): PropertyValue<String>
Get the IconPitchAlignment property
Link copied to clipboard
@NonNull
open fun getIconRotate(): PropertyValue<Float>
Get the IconRotate property
Link copied to clipboard
@NonNull
open fun getIconRotationAlignment(): PropertyValue<String>
Get the IconRotationAlignment property
Link copied to clipboard
@NonNull
open fun getIconSize(): PropertyValue<Float>
Get the IconSize property
Link copied to clipboard
@NonNull
open fun getIconTextFit(): PropertyValue<String>
Get the IconTextFit property
Link copied to clipboard
@NonNull
open fun getIconTextFitPadding(): PropertyValue<Array<Float>>
Get the IconTextFitPadding property
Link copied to clipboard
@NonNull
open fun getIconTranslate(): PropertyValue<Array<Float>>
Get the IconTranslate property
Link copied to clipboard
@NonNull
open fun getIconTranslateAnchor(): PropertyValue<String>
Get the IconTranslateAnchor property
Link copied to clipboard
@NonNull
open fun getIconTranslateTransition(): TransitionOptions
Get the IconTranslate property transition options
Link copied to clipboard
@NonNull
open fun getId(): String
Link copied to clipboard
open fun getMaxZoom(): Float
Link copied to clipboard
open fun getMinZoom(): Float
Link copied to clipboard
@NonNull
open fun getSourceId(): String
Get the source id.
Link copied to clipboard
@NonNull
open fun getSourceLayer(): String
Get the source layer.
Link copied to clipboard
@NonNull
open fun getSymbolAvoidEdges(): PropertyValue<Boolean>
Get the SymbolAvoidEdges property
Link copied to clipboard
@NonNull
open fun getSymbolPlacement(): PropertyValue<String>
Get the SymbolPlacement property
Link copied to clipboard
@NonNull
open fun getSymbolSortKey(): PropertyValue<Float>
Get the SymbolSortKey property
Link copied to clipboard
@NonNull
open fun getSymbolSpacing(): PropertyValue<Float>
Get the SymbolSpacing property
Link copied to clipboard
@NonNull
open fun getSymbolZOrder(): PropertyValue<String>
Get the SymbolZOrder property
Link copied to clipboard
@NonNull
open fun getTextAllowOverlap(): PropertyValue<Boolean>
Get the TextAllowOverlap property
Link copied to clipboard
@NonNull
open fun getTextAnchor(): PropertyValue<String>
Get the TextAnchor property
Link copied to clipboard
@NonNull
open fun getTextColor(): PropertyValue<String>
Get the TextColor property
Link copied to clipboard
@ColorInt
open fun getTextColorAsInt(): Int
The color with which the text will be drawn.
Link copied to clipboard
@NonNull
open fun getTextColorTransition(): TransitionOptions
Get the TextColor property transition options
Link copied to clipboard
@NonNull
open fun getTextField(): PropertyValue<Formatted>
Get the TextField property
Link copied to clipboard
@NonNull
open fun getTextFont(): PropertyValue<Array<String>>
Get the TextFont property
Link copied to clipboard
@NonNull
open fun getTextHaloBlur(): PropertyValue<Float>
Get the TextHaloBlur property
Link copied to clipboard
@NonNull
open fun getTextHaloBlurTransition(): TransitionOptions
Get the TextHaloBlur property transition options
Link copied to clipboard
@NonNull
open fun getTextHaloColor(): PropertyValue<String>
Get the TextHaloColor property
Link copied to clipboard
@ColorInt
open fun getTextHaloColorAsInt(): Int
The color of the text's halo, which helps it stand out from backgrounds.
Link copied to clipboard
@NonNull
open fun getTextHaloColorTransition(): TransitionOptions
Get the TextHaloColor property transition options
Link copied to clipboard
@NonNull
open fun getTextHaloWidth(): PropertyValue<Float>
Get the TextHaloWidth property
Link copied to clipboard
@NonNull
open fun getTextHaloWidthTransition(): TransitionOptions
Get the TextHaloWidth property transition options
Link copied to clipboard
@NonNull
open fun getTextIgnorePlacement(): PropertyValue<Boolean>
Get the TextIgnorePlacement property
Link copied to clipboard
@NonNull
open fun getTextJustify(): PropertyValue<String>
Get the TextJustify property
Link copied to clipboard
@NonNull
open fun getTextKeepUpright(): PropertyValue<Boolean>
Get the TextKeepUpright property
Link copied to clipboard
@NonNull
open fun getTextLetterSpacing(): PropertyValue<Float>
Get the TextLetterSpacing property
Link copied to clipboard
@NonNull
open fun getTextLineHeight(): PropertyValue<Float>
Get the TextLineHeight property
Link copied to clipboard
@NonNull
open fun getTextMaxAngle(): PropertyValue<Float>
Get the TextMaxAngle property
Link copied to clipboard
@NonNull
open fun getTextMaxWidth(): PropertyValue<Float>
Get the TextMaxWidth property
Link copied to clipboard
@NonNull
open fun getTextOffset(): PropertyValue<Array<Float>>
Get the TextOffset property
Link copied to clipboard
@NonNull
open fun getTextOpacity(): PropertyValue<Float>
Get the TextOpacity property
Link copied to clipboard
@NonNull
open fun getTextOpacityTransition(): TransitionOptions
Get the TextOpacity property transition options
Link copied to clipboard
@NonNull
open fun getTextOptional(): PropertyValue<Boolean>
Get the TextOptional property
Link copied to clipboard
@NonNull
open fun getTextPadding(): PropertyValue<Float>
Get the TextPadding property
Link copied to clipboard
@NonNull
open fun getTextPitchAlignment(): PropertyValue<String>
Get the TextPitchAlignment property
Link copied to clipboard
@NonNull
open fun getTextRadialOffset(): PropertyValue<Float>
Get the TextRadialOffset property
Link copied to clipboard
@NonNull
open fun getTextRotate(): PropertyValue<Float>
Get the TextRotate property
Link copied to clipboard
@NonNull
open fun getTextRotationAlignment(): PropertyValue<String>
Get the TextRotationAlignment property
Link copied to clipboard
@NonNull
open fun getTextSize(): PropertyValue<Float>
Get the TextSize property
Link copied to clipboard
@NonNull
open fun getTextTransform(): PropertyValue<String>
Get the TextTransform property
Link copied to clipboard
@NonNull
open fun getTextTranslate(): PropertyValue<Array<Float>>
Get the TextTranslate property
Link copied to clipboard
@NonNull
open fun getTextTranslateAnchor(): PropertyValue<String>
Get the TextTranslateAnchor property
Link copied to clipboard
@NonNull
open fun getTextTranslateTransition(): TransitionOptions
Get the TextTranslate property transition options
Link copied to clipboard
@NonNull
open fun getTextVariableAnchor(): PropertyValue<Array<String>>
Get the TextVariableAnchor property
Link copied to clipboard
@NonNull
open fun getTextVariableAnchorOffset(): PropertyValue<Array<Any>>
Get the TextVariableAnchorOffset property
Link copied to clipboard
@NonNull
open fun getTextWritingMode(): PropertyValue<Array<String>>
Get the TextWritingMode property
Link copied to clipboard
Link copied to clipboard
open fun isDetached(): Boolean
Link copied to clipboard
open fun setDetached()
Link copied to clipboard
open fun setFilter(@NonNull filter: Expression)
Set a single expression filter.
Link copied to clipboard
open fun setIconColorTransition(@NonNull options: TransitionOptions)
Set the IconColor property transition options
Link copied to clipboard
open fun setIconHaloBlurTransition(@NonNull options: TransitionOptions)
Set the IconHaloBlur property transition options
Link copied to clipboard
open fun setIconHaloColorTransition(@NonNull options: TransitionOptions)
Set the IconHaloColor property transition options
Link copied to clipboard
open fun setIconHaloWidthTransition(@NonNull options: TransitionOptions)
Set the IconHaloWidth property transition options
Link copied to clipboard
open fun setIconOpacityTransition(@NonNull options: TransitionOptions)
Set the IconOpacity property transition options
Link copied to clipboard
open fun setIconTranslateTransition(@NonNull options: TransitionOptions)
Set the IconTranslate property transition options
Link copied to clipboard
open fun setMaxZoom(zoom: Float)
Link copied to clipboard
open fun setMinZoom(zoom: Float)
Link copied to clipboard
open fun setProperties(@NonNull properties: Array<PropertyValue<out Any>>)
Link copied to clipboard
open fun setSourceLayer(sourceLayer: String)
Set the source layer.
Link copied to clipboard
open fun setTextColorTransition(@NonNull options: TransitionOptions)
Set the TextColor property transition options
Link copied to clipboard
open fun setTextHaloBlurTransition(@NonNull options: TransitionOptions)
Set the TextHaloBlur property transition options
Link copied to clipboard
open fun setTextHaloColorTransition(@NonNull options: TransitionOptions)
Set the TextHaloColor property transition options
Link copied to clipboard
open fun setTextHaloWidthTransition(@NonNull options: TransitionOptions)
Set the TextHaloWidth property transition options
Link copied to clipboard
open fun setTextOpacityTransition(@NonNull options: TransitionOptions)
Set the TextOpacity property transition options
Link copied to clipboard
open fun setTextTranslateTransition(@NonNull options: TransitionOptions)
Set the TextTranslate property transition options
Link copied to clipboard
@NonNull
open fun withFilter(@NonNull filter: Expression): SymbolLayer
Set a single expression filter.
Link copied to clipboard
@NonNull
open fun withProperties(@NonNull properties: Array<PropertyValue<out Any>>): SymbolLayer
Set a property or properties.
Link copied to clipboard
@NonNull
open fun withSourceLayer(sourceLayer: String): SymbolLayer
Set the source Layer.