AnnotationSublayer

Allows you to interrogate the properties of a sublayer within an annotation layer and to change the visibility of the sublayer. You can get a ListImpl of AnnotationSublayer from AnnotationLayer using LayerContent.subLayerContents. AnnotationSublayer objects only exist as part of an AnnotationLayer object, populated when the AnnotationLayer is loaded. They cannot exist separately. Annotation sublayers offer finer control over your annotation, allowing the author to set different visual properties from the parent annotation layer. These visual properties include font, size, color, or different minimum and maximum scale ranges.

Since

200.1.0

Properties

Link copied to clipboard

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. See the ArcGIS Blog article entitled "Querying Feature Services Date-Time Queries" (https://www.esri.com/arcgis-blog/products/api-rest/data-management/querying-feature-services-date-time-queries/) for more information.

Link copied to clipboard

The maximum scale at which to display the Sublayer.

Link copied to clipboard

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.

Link copied to clipboard

The opacity with which to display 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.

Link copied to clipboard

The property specifies whether the annotation text scales with the MapView. For AnnotationLayer and AnnotationSublayer this is always true.

Link copied to clipboard

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

Inherited properties

Link copied to clipboard
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.

Link copied to clipboard
open override var isVisible: Boolean

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

Link copied to clipboard
open override val name: String

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

Link copied to clipboard
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.

Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Inherited functions

Link copied to clipboard
open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

Link copied to clipboard
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.