Class EsriBasemap

Hierarchy

Accessor
Loadable
JSONSupport
- EsriBasemap

Index

Constructors

constructor

new EsriBasemap(properties?): EsriBasemap
Creates a new basemap object.

Read more...
Parameters
- Optional properties: BasemapProperties
Returns EsriBasemap
Inherited from Accessor.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:1340

Properties

baseLayers

baseLayers: Collection<Layer>

A collection of tile layers that make up the basemap's features.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

id

id: string

An identifier used to refer to the basemap when referencing it elsewhere.

initialized

initialized: boolean

`Readonly` loadError

loadError: Error

The Error object returned if an error occurred while loading.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError)

`Readonly` loadStatus

loadStatus: "loaded" | "loading" | "not-loaded" | "failed"

Represents the status of a load operation.

Default

not-loaded

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus)

`Readonly` loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

`Readonly` loaded

loaded: boolean

Indicates whether the basemap instance has loaded.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#loaded)

portalItem

portalItem: PortalItem

The portal item.

referenceLayers

referenceLayers: Collection<Layer>

A collection of tiled reference layers for displaying labels.

spatialReference

spatialReference: EsriSpatialReference

The spatial reference of the Basemap.

thumbnailUrl

thumbnailUrl: string

The URL pointing to an image that represents the basemap.

title

title: string

The title of the basemap.

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriBasemap
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriBasemap
Inherited from Accessor._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Accessor.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

cancelLoad

cancelLoad(): void
Cancels a load() operation if it is already in progress.

Read more...

Returns void
Inherited from Loadable.cancelLoad
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2220

clone

clone(): EsriBasemap
Creates a deep clone of this object.

Read more...

Returns EsriBasemap
- Defined in node_modules/@arcgis/core/interfaces.d.ts:1346

destroy

destroy(): void
Destroys the basemap, and any associated resources, including its layers and portalItem.

Read more...

Returns void
Inherited from Accessor.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:1352

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Accessor.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from Accessor.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

isFulfilled

isFulfilled(): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Read more...

Returns boolean
Inherited from Loadable.isFulfilled
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2226

isRejected

isRejected(): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.

Read more...

Returns boolean
Inherited from Loadable.isRejected
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2232

isResolved

isResolved(): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.

Read more...

Returns boolean
Inherited from Loadable.isResolved
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2238

load

load(signal?): Promise<any>
Loads the resources referenced by this class.

Read more...
Parameters
- Optional signal: AbortSignal
Returns Promise<any>
Inherited from Loadable.load
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2244

loadAll

loadAll(): Promise<EsriBasemap>
Loads all the externally loadable resources associated with the basemap.

Read more...

Returns Promise<EsriBasemap>
- Defined in node_modules/@arcgis/core/interfaces.d.ts:1358

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from Accessor.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from Accessor.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Accessor.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName, value): EsriBasemap
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriBasemap
Inherited from Accessor.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriBasemap
Parameters
- props: HashMap<any>
Returns EsriBasemap
Inherited from Accessor.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

toJSON

toJSON(): any
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any
Inherited from JSONSupport.toJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2167

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from Accessor.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

when

when(callback?, errback?): Promise<any>
when() may be leveraged once an instance of the class is created.

Read more...
Parameters
- Optional callback: Function
- Optional errback: Function
Returns Promise<any>
Inherited from Loadable.when
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2250

`Static` fromId

fromId(id): EsriBasemap
Creates a new basemap instance from a well known basemap ID.

Read more...
Parameters
- id: string
Returns EsriBasemap
- Defined in node_modules/@arcgis/core/interfaces.d.ts:1364

`Static` fromJSON

fromJSON(json): EsriBasemap
Parameters
- json: any
Returns EsriBasemap
- Defined in node_modules/@arcgis/core/interfaces.d.ts:1365

Class EsriBasemap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: BasemapProperties

Returns EsriBasemap

Properties

baseLayers

declaredClass

destroyed

id

initialized

Readonly loadError

Default

Readonly loadStatus

Default

Readonly loadWarnings

Readonly loaded

Default

portalItem

referenceLayers

spatialReference

thumbnailUrl

title

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriBasemap

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

cancelLoad

Returns void

clone

Returns EsriBasemap

destroy

Returns void

get

Type Parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

hasHandles

Type Parameters

T

Parameters

Optional groupKey: Exclude<T, IHandle>

Returns boolean

isFulfilled

Returns boolean

isRejected

Returns boolean

isResolved

Returns boolean

`Optional` properties: BasemapProperties

`Readonly` loadError

`Readonly` loadStatus

`Readonly` loadWarnings

`Readonly` loaded

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` groupKey: Exclude<T, IHandle>

`Optional` signal: AbortSignal

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>

`Optional` sync: boolean

`Optional` callback: Function

`Optional` errback: Function

`Static` fromId

`Static` fromJSON