ActionToggle

AMD: require(["esri/support/actions/ActionToggle"], (ActionToggle) => { /* code goes here */ });
ESM: import ActionToggle from "@arcgis/core/support/actions/ActionToggle";
Class: esri/support/actions/ActionToggle
Inheritance: ActionToggle ActionBase Accessor
Since: ArcGIS API for JavaScript 4.8

A customizable toggle used in the LayerList widget that performs a specific action(s) which can be toggled on/off.

See also:

Constructors

new ActionToggle(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Booleanmore details

Set this property to true to display a spinner icon.

more detailsActionBase
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates whether this action is disabled.

more detailsActionBase
Stringmore details

The name of the ID assigned to this action.

more detailsActionBase
Stringmore details

The title of the action.

more detailsActionBase
Stringmore details

Specifies the type of action.

more detailsActionToggle
Booleanmore details

Indicates the value of whether the action is toggled on/off.

more detailsActionToggle
Booleanmore details

Indicates if the action is visible.

more detailsActionBase

Property Details

Set this property to true to display a spinner icon. You should do this if the action executes an async operation, such as a query, that requires letting the end user know that a process is ongoing in the background. Set the property back to false to communicate to the user that the process has finished.

Default Value:false
declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

disabled Boolean inherited

Indicates whether this action is disabled.

Default Value:false

The name of the ID assigned to this action. This is used for differentiating actions when listening to the trigger-action event.

The title of the action.

For popups: When space is limited, actions will display in the menu. Text is always shown next to the icon but long text is truncated. A tooltip with this title will display when hovering over it.

For LayerList: The first action is displayed in the layerlist with an icon. The layerlist has a menu that will display all actions with their titles.

type Stringreadonly

Specifies the type of action.

For ActionToggle the type is always "toggle".

Default Value:"toggle"
value Boolean

Indicates the value of whether the action is toggled on/off.

Default Value:false
visible Boolean inherited

Indicates if the action is visible.

Default Value:true

Method Overview

Name Return Type Summary Class
ActionTogglemore details

Creates a deep clone of this object.

more detailsActionToggle

Method Details

clone(){ActionToggle}

Creates a deep clone of this object.

Returns:
Type Description
ActionToggle A clone of the new ActionToggle instance.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.