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).

See also

Basemap.Basemap

()

Constructors

Link copied to clipboard
fun Basemap()

Creates a basemap.

Link copied to clipboard
fun Basemap(basemapStyle: BasemapStyle)

Creates a basemap with a style.

Link copied to clipboard
fun Basemap(item: Item)

Creates basemap with a portal item.

Link copied to clipboard
fun Basemap(baseLayer: Layer?)

Creates basemap with a single base layer.

Link copied to clipboard
fun Basemap(baseLayers: Iterable<Layer>, referenceLayers: Iterable<Layer>)

Create a basemap with base layers and reference layers.

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

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
fun clone(): Basemap

Clones the Basemap.

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.

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.

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

The load status.

Link copied to clipboard
var name: String

The name.

Link copied to clipboard
val referenceLayers: MutableList<Layer>
Link copied to clipboard
open override val unknownJson: Map<String, Any>

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by this API.

Link copied to clipboard
open override val unsupportedJson: Map<String, Any>

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through this API.

Link copied to clipboard
val uri: String?

The basemap's URI.