arcgis-maps-kotlin/com.arcgismaps.mapping.layers/AnnotationSublayer

AnnotationSublayer

A sublayer of the annotation layer. You can change the sublayer's visibility and interrogate its read-only properties, such as the maximum and minimum scale, opacity, and definition expression.

Use the LayerContent.subLayerContents to get a read-only collection of sublayers from the AnnotationLayer. Each AnnotationSublayer object only exists as part of an AnnotationLayer object and is populated when the AnnotationLayer is loaded.

Since

200.1.0

Properties

definitionExpression

val definitionExpression: String

The where-clause of the sql expression that defines which annotation features from the feature table are selected into this sublayer. The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. For more information, see the ArcGIS Blog article https://www.esri.com/arcgis-blog/products/api-rest/data-management/querying-feature-services-date-time-queries/.

maxScale

val maxScale: Double?

The maximum scale at which to display the Sublayer.

minScale

val minScale: Double?

The minimum scale at which to display the Sublayer. Zero indicates that the annotation will be visible no matter how far the user zooms out.

opacity

val opacity: Float

The opacity of the annotation text associated with this Sublayer. Opacity is a value between 0 and 1, with 0 indicating that the annotation will be completely transparent, and 1 indicating that the annotation will be completely opaque.

scaleSymbols

val scaleSymbols: Boolean

True if the annotation text scales with the MapView. The scaleSymbols value is always true.

sublayerId

val sublayerId: Long

Non-negative integer id number of the AnnotationSublayer within its AnnotationLayer.

Inherited properties

canChangeVisibility

open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

isVisible

open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

name

open override val name: String

The layer content's name. The layer content name.

showInLegend

open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

subLayerContents

open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Inherited functions

fetchLegendInfos

open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

isVisibleAtScale

open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.