@arcgis/map-components
Version:
ArcGIS Map Components
94 lines (93 loc) • 4.73 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type Basemap from "@arcgis/core/Basemap.js";
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { ArcgisReferenceElement } from "../types.js";
import type { BasemapProperties } from "@arcgis/core/Basemap.js";
import type { T9nMeta } from "@arcgis/lumina/controllers";
import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
import type { BasemapToggleViewModelState } from "@arcgis/core/widgets/BasemapToggle/BasemapToggleViewModel.js";
/**
* The Basemap Toggle component allows an end-user to switch between two basemaps.
*
* The basemaps can have different spatial references.
*
* @since 4.28
*/
export abstract class ArcgisBasemapToggle extends LitElement {
/** The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap). */
get activeBasemap(): Basemap | null | undefined;
/**
* If true, the component will not be destroyed automatically when it is
* disconnected from the document. This is useful when you want to move the
* component to a different place on the page, or temporarily hide it. If this
* is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
accessor autoDestroyDisabled: boolean;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
*
* @default "layer-basemap"
* @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
*/
accessor icon: string | undefined;
/** The component's default label. */
accessor label: string | undefined;
/**
* Replace localized message strings with your own strings.
*
* _**Note**: Individual message keys may change between releases._
*/
accessor messageOverrides: {
componentLabel?: string | undefined;
incompatibleSpatialReference?: string | undefined;
};
/** @internal */
protected messages: Partial<{
componentLabel: string;
incompatibleSpatialReference: string;
}> & T9nMeta<{
componentLabel: string;
incompatibleSpatialReference: string;
}>;
/** The next basemap for toggling. */
accessor nextBasemap: BasemapProperties | string | undefined;
/**
* By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
*
* @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
*/
accessor referenceElement: ArcgisReferenceElement | string | undefined;
/**
* Indicates if the Basemap title is displayed.
*
* @default false
*/
accessor showTitle: boolean;
/**
* The current state of the component.
*
* @default "disabled"
*/
get state(): BasemapToggleViewModelState;
/**
* The view associated with the component.
* > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-basemap-toggle component will be associated with a map or scene component rather than using the `view` property.
*/
accessor view: MapViewOrSceneView | null | undefined;
/** Permanently destroy the component. */
destroy(): Promise<void>;
/** Toggles to the [nextBasemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#nextBasemap). */
toggle(): Promise<any>;
/** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "activeBasemap" | "nextBasemap" | "state"; }>;
/** Emitted when the component associated with a map or scene view is ready to be interacted with. */
readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
arcgisPropertyChange: ArcgisBasemapToggle["arcgisPropertyChange"]["detail"];
arcgisReady: ArcgisBasemapToggle["arcgisReady"]["detail"];
};
}