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

EncLayer

A layer that displays ENC data. Electronic navigational charts (ENC) are georeferenced vector datasets for the visualization and analysis of hydrographic and maritime information. This API supports ENC that conform to the International Hydrographic Organization (IHO) S-57 standard.

Functional characteristics ENC layer supports identify and selection but does not support query or time. ENC layers cannot be displayed in a scene.

Performance characteristics ENC layers differ from other layer types in that ENC content is cached in an internal collection of SENC files. When an ENC layer is displayed, only the content in the SENC files is referenced. SENC files are produced when an ENC cell is read for the first time and updated as update sets are applied. You can set the path to the SENC storage directory with the EncEnvironmentSettings.sencDataPath property. SENC files are in a binary format that is not intended to be shared between platforms or versions of this API.

Since

200.1.0

Constructors

EncLayer

fun EncLayer(encCell: EncCell)

Creates a new ENC layer from an ENC cell.

Properties

cell

val cell: EncCell

Returns the ENC cell object associated with the ENC layer. Use this method to obtain a reference to the ENC cell held by the layer.

Inherited properties

attribution

open val attribution: String

The attribution text for the layer.

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.

description

var description: String

The description for the layer. The description of the layer.

fullExtent

val fullExtent: Envelope?

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from the tables extent.

var id: String

The unique identifying string for the layer, for example specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.

isIdentifyEnabled

val isIdentifyEnabled: Boolean

Whether the layer supports identify. If the layer is not loaded it may return false if identify support is determined by metadata that is not yet available.

isVisible

open override var isVisible: Boolean

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

item

val item: Item?

The item the layer has been created from.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

maxScale

var maxScale: Double?

The maximum scale for the layer. This controls the maximum scale level the layer can zoom to. All of the connected map views will be updated.

minScale

var minScale: Double?

The minimum scale for the layer. This controls the minimum scale level the layer can zoom to. All of the connected map views will be updated.

name

open override var name: String

The name of this layer.

opacity

var opacity: Float

The opacity for the layer. All of the connected map views will be updated.

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.

spatialReference

val spatialReference: SpatialReference?

The spatial reference of the layer.

subLayerContents

open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

visibilityChanged

val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.

Functions

clearSelection

fun clearSelection()

Clears / Unselects a previously selected ENC feature (if any).

clone

open override fun clone(): EncLayer

Clones the EncLayer.

selectFeature

fun selectFeature(encFeature: EncFeature)

Selects an ENC feature. Only one ENC feature can be selected at a time. Note that some ENC features are rendered as multiple objects on the map - for example, a soundings feature might consist of many individual measurements, each of which will be highlighted when the feature is selected.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

equals

open operator override fun equals(other: Any?): Boolean

fetchLegendInfos

open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

hashCode

open override fun hashCode(): Int

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.