ArcGISMapImageSublayer

A sublayer of an ArcGIS map image layer. ArcGISMapImageSublayer provides access to layers that comprise an ArcGISMapImageLayer. Once the ArcGISMapImageLayer has loaded, you can obtain its sublayers from the ArcGISMapImageLayer.mapImageSublayers collection. If one of the sublayers is a group layer (where the ArcGISMapServiceSublayerInfo.sublayerType is ArcGISMapServiceSublayerType.GroupLayer), it will also have a collection of sublayers. Use ArcGISSublayer.sublayers to obtain the collection of sublayers. If one of these sublayers is a group layer it will also contains a collection of sublayers, and so on.

If you know the sublayer Id, you can create a it from the ArcGISMapImageSublayer.ArcGISMapImageSublayer(Long) constructor.

Once you have obtained the sublayer, you can change the data that is displayed by the ArcGISMapImageLayer by setting the sublayer's visibility, layer definition expression, and other visual properties such as renderer and scale.

Since

200.1.0

See also

ArcGISMapImageSublayer.ArcGISMapImageSublayer

(Long)

Constructors

Link copied to clipboard
constructor(id: Long, sublayerSource: SublayerSource? = null)

Create a map image sublayer with the specified id and the specified sublayer source. Only map services that support dynamic layers will be able to manage sublayers with sublayer sources.

Properties

Link copied to clipboard

The sublayer's default visibility. The sublayer default visibility. Will return false if an error occurs.

Link copied to clipboard
open override var definitionExpression: String

A SQL statement where clause that stipulates a subset of features to be displayed. 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

A modifiable collection of label definitions for this sublayer. This is only available if the ArcGISMapImageLayer supports dynamic capabilities.

Link copied to clipboard
open override var labelsEnabled: Boolean

True if the sublayer's labels are enabled, false otherwise. Will return false if an error occurs.

Link copied to clipboard
open override var maxScale: Double?

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

Link copied to clipboard
open override var minScale: Double?

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

Link copied to clipboard
open override var name: String

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

Link copied to clipboard
open override var opacity: Float

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

Link copied to clipboard
open override var renderer: Renderer?

The sublayer's renderer.

Link copied to clipboard
open override var scaleSymbols: Boolean

True if the sublayer renderers its symbols based on scale, false otherwise. Will return false if an error occurs.

Link copied to clipboard

The sublayer's source if available.

Link copied to clipboard

The sublayer's feature table. This only applies to sublayers of type ArcGISMapServiceSublayerType.FeatureLayer or ArcGISMapServiceSublayerType.Table. This method returns null if the sublayer has not been loaded.

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
val id: Long

The id that uniquely identifies this sublayer. Will return -1 if an error occurs.

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

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 loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard

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.

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

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.

Link copied to clipboard

The collection of sublayers of a sublayer. This collection is usually empty unless the parent layer is loaded. Modifying this collection has no effect unless this sublayer is associated with an ArcGIS map service that supports dynamic layers. "Supports Dynamic Layers" must be set to true in the ArcGIS MapServer REST Services Directory.

Functions

Link copied to clipboard
open override fun clone(): ArcGISMapImageSublayer

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.