Property Overview

Property Details

basemapsCollection<Basemap>

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

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

filterFunctionFunction

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

portalPortal

The Portal from which to fetch basemaps.

queryObject|String

Since: ArcGIS API for JavaScript 4.5

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.

Examples:

// query portal basemaps with an object
var source = new PortalBasemapsSource({
  query: {
    title: "United States Basemaps",
    owner: "Esri_cy_US"
  }
});

// query portal basemaps with a string
var source = new PortalBasemapsSource({
  query: "title:\"United States Basemaps\" AND owner:Esri_cy_US"
});

stateStringreadonly

The source's state.

Possible Values: not-loaded | loading | ready

Default Value:not-loaded

updateBasemapsCallbackFunction

Since: ArcGIS API for JavaScript 4.8

Callback for updating basemaps after being fetched and filtered.

Method Overview

Method Details

refresh()

Refreshes basemaps by fetching them from the Portal.