ArcGISVectorTiledLayer

class ArcGISVectorTiledLayer : Layer, ApiKeyResource

Displays data from an ArcGIS vector tiled data source. The ArcGIS Vector Tiled Layer is similar to the ArcGIS Tiled Layer. An ArcGIS Vector Tiled Layer is loaded from ArcGIS online, ArcGIS Enterprise, ArcGIS Server, or a local vector tile layer package file. The tile data format is optimized to reduce network bandwidth and reduce CPU load while rendering the tiles. Vector Tiled Layers are appropriate for basemap, reference and possibly operational layers. They do not contain any feature data, and do not support identify or search operations.

Vector tiles are an alternative to raster tile basemap layers. Instead of pixels (raster), the cartography is delivered using 2D points. The points describe lines, polygons, or the locations of labels and marker symbols. The file format of tiles is binary and conforms to the Mapbox Vector Tile Specification. This specification allows a more continuous visual experience between levels of detail compared to raster tiles. The vector tile file format also requires less space than raster tiles.

You can create a vector tiled layer using either a URI or a portal item. The URI can point to a vector tile source, a vector tile style sheet, or a local vector tile package file. The portal item will contain a URI to a vector tile stylesheet. The style sheet describes the appearance of the geometry and must be in the Mapbox GL Style format. The style sheet also contains a URI to a vector tile source. The source must be in the Mapbox TileJSON format. The source info includes a URI to a default style sheet.

More than one vector tile style sheet can use the same source. Both the source info and the style sheet are human readable JSON files.

Vector tile packages can also be downloaded from a ArcGIS Online vector tile service. The vector tile package is a single file (.vptk) that contains all of the tile data files, the source information, a style sheet, and the font and symbol marker resources required to display the map.

Vector tile packages are also distributed inside Mobile Map Packages. The MMPK contains JSON that points to the location of the vector tile style sheet or the root of the vector tile package data.

See also

Constructors

Link copied to clipboard
fun ArcGISVectorTiledLayer(item: Item)

Creates an ArcGIS Vector Tiled Layer object from an item.

Link copied to clipboard
fun ArcGISVectorTiledLayer(uri: String)

Creates an ArcGIS Vector Tiled Layer object. Use this object to create an ArcGIS vector tiled layer.

Link copied to clipboard
fun ArcGISVectorTiledLayer(vectorTileCache: VectorTileCache, itemResourceCache: ItemResourceCache? = null)

Creates an ArcGIS Vector Tiled Layer object from a vector tile cache and an item resource cache containing a custom style for this vector tile layer.

Functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open override fun clone(): ArcGISVectorTiledLayer
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
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 hashCode(): Int
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.

Properties

Link copied to clipboard
open override var apiKey: ApiKey?

An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services.

Link copied to clipboard
val attribution: String

The attribution text for the layer.

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
var description: String

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

Link copied to clipboard
val fullExtent: Envelope?
Link copied to clipboard
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.

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

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
val item: Item?
Link copied to clipboard
val itemResourceCache: ItemResourceCache?
Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard
var maxScale: Double?

The maximum scale for the layer. If it is null, there is no maximum. This controls the maximum scale level the layer can zoom to. All of the connected map views will be updated.

Link copied to clipboard
var minScale: Double?

The minimum scale for the layer. If it is null, there is no minimum. This controls the minimum scale level the layer can zoom to. All of the connected map views will be updated.

Link copied to clipboard
open override val name: String

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

Link copied to clipboard
var opacity: Float

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

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
val sourceInfo: VectorTileSourceInfo?
Link copied to clipboard
val spatialReference: SpatialReference?
Link copied to clipboard
val style: VectorTileStyle?
Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Link copied to clipboard
val uri: String?

The URI of the ArcGIS vector tiled layer.

Link copied to clipboard
val vectorTileCache: VectorTileCache?
Link copied to clipboard
val visibilityChanged: SharedFlow<Boolean>

Callback invoked when the visibility of the layer changes.