@arcgis/core/views/BasemapView.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

import type Accessor from "../core/Accessor.js";
import type Collection from "../core/Collection.js";
import type LayerView from "./layers/LayerView.js";
import type { MapViewOrSceneView } from "./MapViewOrSceneView.js";

export interface BasemapViewProperties<TLayerView extends LayerView = LayerView> {
  /** References the [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). */
  view?: MapViewOrSceneView | null;
}

/**
 * Represents the view for a single basemap after it has been added to either a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
 *
 * @since 4.13
 * @see [MapView.basemapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#basemapView)
 * @see [SceneView.basemapView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#basemapView)
 */
export default class BasemapView<TLayerView extends LayerView = LayerView> extends Accessor {
  constructor(properties?: BasemapViewProperties<TLayerView>);
  /**
   * A collection containing a hierarchical list of all the created
   * [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) of the
   * base layers in the map.
   */
  get baseLayerViews(): Collection<TLayerView>;
  /**
   * A collection containing a hierarchical list of all the created
   * [LayerViews](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/) of the
   * reference layers in the map. The reference layers will be displayed on top of all layers in the map.
   */
  get referenceLayerViews(): Collection<TLayerView>;
  /**
   * Value is `true` when the basemap is updating; for example, if
   * it is in the process of fetching data.
   *
   * @default false
   */
  get updating(): boolean;
  /** References the [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/). */
  get view(): MapViewOrSceneView | null | undefined;
}