Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Basemap

Hierarchy

Index

Properties

baseLayers

baseLayers: Collection<Layer>

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

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

id

id: string

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

Read more...

initialized

initialized: boolean

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

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

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the basemap instance has loaded.

Read more...

portalItem

portalItem: PortalItem

The portal item.

Read more...

referenceLayers

referenceLayers: Collection<Layer>

A collection of tiled reference layers for displaying labels.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the Basemap.

Read more...

thumbnailUrl

thumbnailUrl: string

The URL pointing to an image that represents the basemap.

Read more...

title

title: string

The title of the basemap.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Basemap
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Basemap

cancelLoad

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

    Read more...

    Returns void

clone

  • Creates a deep clone of this object.

    Read more...

    Returns Basemap

destroy

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

    Read more...

    Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

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

isRejected

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

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

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

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

loadAll

  • Loads all the externally loadable resources associated with the basemap.

    Read more...

    Returns Promise<Basemap>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Basemap

  • Parameters

    Returns Basemap

toJSON

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

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): 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>

Generated using TypeDoc