arcgis-link-chart-nonspatial-visibility-toggle | References

ESM

import "@arcgis/map-components/components/arcgis-link-chart-nonspatial-visibility-toggle";

Inheritance:: ArcgisLinkChartNonspatialVisibilityToggle→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 5.0

The component is for use in link charts that allows users to switch whether or not nonspatial data is visible in the view. Spatial entities are those with a value in a defined geometry property in a traditional map context. A Spatial relationship is one where both endpoints are spatial

Note: Sign in to access the data in this demo, U/P: viewer01/I68VGU^nMurF

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`icon`	`icon`	`IconName \| undefined`
`label`	`label`	`string \| undefined`
`messageOverrides`		`Record<string, unknown> \| undefined`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`state` readonly		`State`
`view`		`LinkChartView \| undefined`
`visualScale`	`visual-scale`	`"l" \| "m" \| "s"`

autoDestroyDisabled

Property

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

icon

Property

Type: IconName | undefined

Attribute: icon

label

Property

Type: string | undefined

The component's default label.

Attribute: label

messageOverrides

Property

Type: Record<string, unknown> | undefined

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

By assigning the id attribute of the LinkChart component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the LinkChart.

state

readonly Property

Type: State

The current state of the component.

Default value: "loading"

view

Property

Type: LinkChartView | undefined

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-link-chart-nonspatial-visibility-toggle component will be associated with a map or scene component rather than using the view property.

visualScale

Property

Type: "l" | "m" | "s"

Specifies the size of the component.

Attribute: visual-scale
Default value: "m"

Methods

Method	Signature
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`destroy`	`destroy(): Promise<void>`
`switchNonspatialVisibility`	`switchNonspatialVisibility(nonspatialVisibilitySetting: NonspatialMode): Promise<void>`

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisLinkChartNonspatialVisibilityToggle = document.querySelector("arcgis-link-chart-nonspatial-visibility-toggle");
document.body.append(arcgisLinkChartNonspatialVisibilityToggle);
await arcgisLinkChartNonspatialVisibilityToggle.componentOnReady();
console.log("arcgis-link-chart-nonspatial-visibility-toggle is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

switchNonspatialVisibility

Method

Signature: switchNonspatialVisibility (nonspatialVisibilitySetting: NonspatialMode): Promise<void>

Switches the nonspatial visibility setting

Parameters

Parameter	Type	Description	Required
nonspatialVisibilitySetting	`NonspatialMode`

Returns: Promise<void>

Events

Name	Type
`arcgisPropertyChange`	CustomEvent<{ name: "state"; }>
`arcgisReady`	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state"; }>

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

arcgisReady

Event

arcgisReady: CustomEvent<void>

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