import "@arcgis/map-components/components/arcgis-basemap-toggle";
Basemap Toggle component allows an end-user to switch between two basemaps.
The basemaps can have different spatial references.
Demo
Properties
Property | Attribute | Type |
---|---|---|
activeBasemap readonly |
| |
auto-destroy-disabled | boolean | |
icon | string | |
label | string | |
| {
componentLabel?: string | undefined;
incompatibleSpatialReference?: string | undefined;
} | |
| ||
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
show-title | boolean | |
state readonly | state | "disabled" | "incompatible-next-basemap" | "loading" | "ready" |
autoDestroyDisabled
autoDestroyDisabled: boolean
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 temporary hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
icon
icon: string
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- Attribute
- icon
- Default value
- "layer-basemap"
messageOverrides
messageOverrides: {
componentLabel?: string | undefined;
incompatibleSpatialReference?: string | undefined;
}
Replace localized message strings with your own strings.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
- Attribute
- position
- Default value
- "top-left"
referenceElement
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
showTitle
showTitle: boolean
Indicates if the Basemap title is displayed.
- Attribute
- show-title
- Default value
- false
state
state: "disabled" | "incompatible-next-basemap" | "loading" | "ready"
The current state of the component.
- Attribute
- state
- Default value
- "disabled"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
toggle(): Promise<any> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state" | "nextBasemap"; } | |
undefined |