ArcGISMapImageSublayer

An ArcGIS map image sublayer. ArcGISMapImageLayer displays maps from an ArcGIS map server. Each layer in the underlying map service is represented by an ArcGISSublayer. You can control the visibility and symbols of sublayers and filter data with layer definition expressions.

You can get this object from ArcGISMapImageLayer.mapImageSublayers once the map image layer is loaded or you can get a collection of handles from another map image sublayer by using ArcGISSublayer.sublayers. You can also create a new sublayer from ArcGISMapImageSublayer.ArcGISMapImageSublayer(Long).

Since

200.1.0

See also

ArcGISMapImageSublayer.ArcGISMapImageSublayer

(Long)

Constructors

Link copied to clipboard
fun ArcGISMapImageSublayer(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

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.

Link copied to clipboard

The collection of LabelDefinition objects for this layer.

Link copied to clipboard
open override var labelsEnabled: Boolean

The flag indicating whether the sublayer's labels are enabled/disabled. 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

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

Link copied to clipboard

The sublayer's source. The sublayer source.

Link copied to clipboard

The sublayer's feature table. This only applies to sublayers of type "Feature layer" or "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 sublayer's Id. The sublayer ID. 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 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).

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.