Link Chart Layout Switcher

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"

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 method when you are done to prevent memory leaks.

Attribute

auto-destroy-disabled

Default value

false

When 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 displayed in the component's button, when appearance is dropdown.

See also

• Calcite Icon Search

Attribute

icon

Default value

"nodes-link"

The component's default label.

Attribute

label

The current selected link chart layout.

Read more...

Default value

"organic-standard"

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

Attribute

position

Prevents extent from updating on changes to the layout.

Read more...

Attribute

prevent-extent-update

Default value

false

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 also:

• Associate components with a Map or Scene component

Attribute

reference-element

The current state of the component.

Attribute

state

Default value

"loading"

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 Link Chart Layout Switcher component will be associated with a map or scene component rather than using the view property.

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
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>

Permanently destroy the component.

Returns

Promise<void>

Switches the layout of the link chart to the value provided.

Parameters

Returns

Promise<void>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is ready to be interacted with.

Fires when component has completed the layout switch

Example

1
2
3
layoutswitcher.addEventListener("arcgisSwitchLayout", (event) => {
  console.log("Layout Switched");
});