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

ArcGISSublayer

sealed class ArcGISSublayer : LayerContent, Loadable, PopupSource

An ArcGIS sublayer. This is a base class for ArcGISMapImageSublayer and ArcGISTiledSublayer. You can get a collection of handles from another sublayer by using ArcGISSublayer.sublayers.

Since

200.1.0

Properties

definitionExpression

open val definitionExpression: String

The sublayer's definition expression. 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.

val id: Long

The sublayer's Id. The sublayer ID. Will return -1 if an error occurs.

labelsEnabled

open val labelsEnabled: Boolean

The flag indicating whether the sublayer's labels are enabled/disabled. Will return false if an error occurs.

mapServiceSublayerInfo

val mapServiceSublayerInfo: ArcGISMapServiceSublayerInfo?

The sublayer's metadata. The sublayer metadata once the sublayer is loaded. Will return null if an error occurs or if the sublayer is not loaded.

maxScale

open val maxScale: Double?

The sublayer's maximum scale. The sublayer maximum scale. Will return NAN if an error occurs.

minScale

open val minScale: Double?

The sublayer's minimum scale. The sublayer minimum scale. Will return NAN if an error occurs.

opacity

open val opacity: Float

The sublayer's opacity. Will return NAN if an error occurs.

renderer

open val renderer: Renderer?

The sublayer's renderer.

scaleSymbols

open val scaleSymbols: Boolean

The flag indicating whether the sublayer renderers its symbols based on scale. Will return false if an error occurs.

sublayers

val sublayers: MutableList<ArcGISSublayer>

The sublayers of a sublayer. The collection is specific to a layer so you can't reuse a sublayer collection coming from another ArcGISMapImageLayer or ArcGISSublayer. You have to create a new layer collection by using MutableListImpl.MutableListImpl(CoreElementType).

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.

isPopupEnabled

open override var isPopupEnabled: Boolean

A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. 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.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

name

open override val name: String

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

popupDefinition

open override var popupDefinition: PopupDefinition?

The pop-up definition. The PopupDefinition associated with the popup source. A null if an error occurs or if the popup source is not associated with a pop-up definition.

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.

Functions

clone

abstract fun clone(): ArcGISSublayer

Clones the ArcGISSublayer.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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.

load