PortalBasemapsSource | References | ArcGIS Maps SDK for JavaScript

import PortalBasemapsSource from "@arcgis/core/basemapGallery/PortalBasemapsSource.js";

const PortalBasemapsSource = await $arcgis.import("@arcgis/core/basemapGallery/PortalBasemapsSource.js");

Inheritance: PortalBasemapsSource→LocalBasemapsSource→BasemapsSource→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

A Portal-driven source for Basemaps in a BasemapGalleryModel.

See also

BasemapGalleryModel.source

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	PortalBasemapsSourceProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
basemaps readonly	Collection<Basemap>
declaredClass readonly inherited	string	Accessor
filterFunction	BasemapFilter \| null \| undefined
loadError readonly inherited	EsriError \| null \| undefined	LoadableMixin
loadStatus readonly inherited	"not-loaded" \| "loading" \| "failed" \| "loaded"	LoadableMixin
loadWarnings readonly inherited	any[]	LoadableMixin
portal	Portal
query	Record<string, any> \| string \| null \| undefined
state readonly	BasemapsSourceState
updateBasemapsCallback	UpdateBasemapsCallback \| null \| undefined

basemaps

readonly Property

Type: Collection<Basemap>

A collection of Basemaps fetched from the source's Portal.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

filterFunction

Property

Type: BasemapFilter | null | undefined

Function used to filter basemaps after being fetched from the Portal.

loadError

readonlyinherited Property

Type: EsriError | null | undefined

Inherited from: LoadableMixin

The Error object returned if an error occurred while loading.

loadStatus

readonlyinherited Property

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

Inherited from: LoadableMixin

Represents the status of a load() operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default value: "not-loaded"

loadWarnings

readonlyinherited Property

Type: any[]

Inherited from: LoadableMixin

A list of warnings which occurred while loading.

portal

autocast Property

Type: Portal

The Portal from which to fetch basemaps.

query

Property

Type: Record<string, any> | string | null | undefined

An object with key-value pairs used to create a custom basemap gallery group query. Note that all parameters will be joined using the AND operator. A query string can also be provided for more advanced use cases.

state

readonly Property

Type: BasemapsSourceState

The source's state.

Default value: "not-loaded"

updateBasemapsCallback

Property

Type: UpdateBasemapsCallback | null | undefined

Callback for updating basemaps after being fetched and filtered.

Methods

Method	Signature	Class
cancelLoad inherited	cancelLoad(): this	LoadableMixin
destroy	destroy(): void
isFulfilled inherited	isFulfilled(): boolean	EsriPromiseMixin
isRejected inherited	isRejected(): boolean	EsriPromiseMixin
isResolved inherited	isResolved(): boolean	EsriPromiseMixin
load	load(options?: AbortOptions \| null \| undefined): Promise<this>
refresh	refresh(): Promise<void>
when inherited	when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>	EsriPromiseMixin

cancelLoad

inherited Method

Signature: cancelLoad (): this

Inherited from: LoadableMixin

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

Returns: this

destroy

Method

Signature: destroy (): void

Destroys the Portal basemaps source.

Returns: void

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

isFulfilled() may be used to verify whether the promise has been fulfilled (either resolved or rejected).

Returns: boolean
Whether the promise has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

isRejected() may be used to verify whether the promise has been rejected.

Returns: boolean
Whether the promise has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

isResolved() may be used to verify whether the promise has resolved.

Returns: boolean
Whether the promise has resolved.

load

Method

Signature: load (options?: AbortOptions | null | undefined): Promise<this>

Loads the source's Portal.

Parameters

Parameter	Type	Description	Required
options	AbortOptions \| null \| undefined	Options for aborting the load.

Returns: Promise<this>
A promise that resolves with this source when the Portal has loaded.

refresh

Method

Signature: refresh (): Promise<void>

Refreshes basemaps by fetching them from the Portal.

Returns: Promise<void>
A promise that resolves when the basemaps have been fetched.

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

Since: ArcGIS Maps SDK for JavaScript 4.6

when() may be used with an instance of this class. This method takes two input parameters: an onFulfilled function and an onRejected function. The onFulfilled function executes when the promise resolves. The onRejected function executes if the promise is rejected.

Parameters

Parameter	Type	Description	Required
onFulfilled	OnFulfilledCallback<this, TResult1> \| null \| undefined	The function to call when the promise resolves.
onRejected	OnRejectedCallback \| null \| undefined	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});