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

ArcGISMapImageSublayer

class ArcGISMapImageSublayer : ArcGISSublayer

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.getMapImageSublayers() once the map image layer is loaded or you can get a collection of handles from another map image sublayer by using ArcGISSublayer.getSublayers(). You can also create a new sublayer from ArcGISMapImageSublayer.ArcGISMapImageSublayer(Long).

Constructors

ArcGISMapImageSublayer

fun ArcGISMapImageSublayer(id: Long)

Create a map image sublayer with the specified id.

ArcGISMapImageSublayer

fun ArcGISMapImageSublayer(id: Long, sublayerSource: SublayerSource)

Create a map image sublayer with the specified id and a sublayer source. 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.

Functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

clone

open override fun clone(): ArcGISMapImageSublayer

Clones the ArcGISMapImageSublayer.

equals

fun equals(handle2: ArcGISSublayer): Boolean

Tests if this object is equal to a second ArcGISSublayer 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

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

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.

defaultVisibility

val defaultVisibility: Boolean

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

definitionExpression

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.

val id: Long

The sublayer's Id. The sublayer ID. Will return -1 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.

labelDefinitions

val labelDefinitions: MutableList<LabelDefinition>

labelsEnabled

open override var labelsEnabled: Boolean

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

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

mapServiceSublayerInfo

val mapServiceSublayerInfo: ArcGISMapServiceSublayerInfo?

maxScale

open override var maxScale: Double

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

minScale

open override var minScale: Double

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

name

open override var name: String

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

opacity

open override var opacity: Float

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

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.

renderer