arcgis-maps-kotlin/com.arcgismaps.mapping/Basemap

Basemap

class Basemap : ApiKeyResource, JsonSerializable, Loadable

The basemap contains layers which are base or reference layers. Typically, you will use one basemap layer that is drawn beneath all other layers, but you can also add a basemap layer on top of all other layers to depict boundaries, labels, or a road network. In order to take advantage of geographically load balanced services and monitor usage with API keys or named users, use Basemap.Basemap(BasemapStyle).

Constructors

Basemap

fun Basemap()

Creates a basemap.

Basemap

fun Basemap(basemapStyle: BasemapStyle)

Creates a basemap with a style.

Basemap

fun Basemap(item: Item)

Creates basemap with a portal item.

Basemap

fun Basemap(baseLayer: Layer?)

Creates basemap with a single base layer.

Basemap

fun Basemap(baseLayers: Iterable<Layer>, referenceLayers: Iterable<Layer>)

Create a basemap with base layers and reference layers.

Basemap

fun Basemap(uri: String)

Creates basemap with an URI. If the specified URI is a portal item URL (see PortalItem.PortalItem(String) for the supported URL formats), the underlying PortalItem will be created and accessible through Basemap.getItem().

Types

Companion

object Companion

Functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

clone

fun clone(): Basemap

Clones the Basemap.

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.

toJson

open override fun toJson(): String

Convert an object to JSON string.

Properties

apiKey

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.

baseLayers