import "@arcgis/map-components/components/arcgis-link-chart-layout-switcher";A component for use in link charts that allows users to switch between different layouts. See documentation on layouts for more details.
Note: Sign in to access the data in this demo, U/P: viewer01/I68VGU^nMurF
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
appearance | "dropdown" | "menu-bar" | |
auto-destroy-disabled | boolean | |
close-on-select-disabled | boolean | |
icon | string | |
label | string | |
layoutreadonly | | "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "organic-community" | "organic-standard" | "radial-root-centric" | "tree-left-to-right" |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
prevent-extent-update | boolean | |
reference-element | ||
statereadonly | state | "disabled" | "loading" | "ready" |
appearance
appearance: "dropdown" | "menu-bar"The appearance of the layout switcher. dropdown displays a button that is clicked to reveal a dropdown menu, while menu-bar displays a menu bar.
- Attribute
- appearance
- Default value
- "dropdown"
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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 method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
closeOnSelectDisabled
closeOnSelectDisabled: booleanWhen true, the layout menu will not close when a layout is selected. Only applicable when appearance is dropdown.
- Attribute
- close-on-select-disabled
- Default value
- false
icon
icon: stringIcon displayed in the component's button, when appearance is dropdown.
- See also
- Attribute
- icon
- Default value
- "nodes-link"
layout
layout: "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "organic-community" | "organic-standard" | "radial-root-centric" | "tree-left-to-right"The current selected link chart layout.
- Default value
- "organic-standard"
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
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"
preventExtentUpdate
preventExtentUpdate: booleanPrevents extent from updating on changes to the layout.
- Attribute
- prevent-extent-update
- Default value
- false
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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 also:
- Attribute
- reference-element
state
state: "disabled" | "loading" | "ready"The current state of the component.
- Attribute
- state
- Default value
- "loading"
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> | |
LinkChartLayoutSwitcherViewModelSwitchLayoutEvent |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisSwitchLayout
arcgisSwitchLayout: LinkChartLayoutSwitcherViewModelSwitchLayoutEventFires when component has completed the layout switch
Example
layoutswitcher.addEventListener("arcgisSwitchLayout", (event) => {
console.log("Layout Switched");
});Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
switchLayout(newLayout: "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "organic-community" | "organic-standard" | "radial-root-centric" | "tree-left-to-right"): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisLinkChartLayoutSwitcher = document.querySelector("arcgis-link-chart-layout-switcher");
document.body.append(arcgisLinkChartLayoutSwitcher);
await arcgisLinkChartLayoutSwitcher.componentOnReady();
console.log("arcgis-link-chart-layout-switcher is ready to go!");- Returns
- Promise<void>
switchLayout
switchLayout(newLayout: "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "organic-community" | "organic-standard" | "radial-root-centric" | "tree-left-to-right"): Promise<void>Switches the layout of the link chart to the value provided.
Parameters
| Parameter | Type | Optional? |
|---|---|---|
newLayout | "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "organic-community" | "organic-standard" | "radial-root-centric" | "tree-left-to-right" |
- Returns
- Promise<void>