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 |
|---|---|---|
auto-destroy-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" |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
prevent-extent-update | boolean | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
statereadonly | state | "disabled" | "loading" | "ready" |
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
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"
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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string- Attribute
- reference-element
state
state: "disabled" | "loading" | "ready"The current state of the widget.
- Attribute
- state
- Default value
- "loading"
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.
- 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>
Events
| Event | Type |
|---|---|
{ name: "state"; } | |
undefined | |
LinkChartLayoutSwitcherViewModelSwitchLayoutEvent |
arcgisPropertyChange
arcgisPropertyChange: { 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: undefinedEmitted when the component associated with a map 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
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.