ActionToggle | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

See also

Sample - LayerList widget with actions

Constructors

ActionToggle Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Boolean	Set this property to `true` to display a spinner icon.	ActionBase
String	The name of the class.	Accessor
Boolean	Indicates whether this action is disabled.	ActionBase
String	Calcite icon used for the action.	ActionBase
String	The name of the ID assigned to this action.	ActionBase
String	The title of the action.	ActionBase
String	Specifies the type of action.	ActionToggle
Boolean	Indicates the value of whether the action is toggled on/off.	ActionToggle
Boolean	Indicates if the action is visible.	ActionBase

Property Details

active Inherited Property active Boolean Inherited from ActionBase

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 Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

disabled Inherited Property disabled Boolean Inherited from ActionBase

Indicates whether this action is disabled.

Default Value:false

icon Inherited Property icon String Inherited from ActionBase Since: ArcGIS Maps SDK for JavaScript 4.27 ActionBase since 4.8, icon added at 4.27.

Calcite icon used for the action.

Default Value:null

See also

Calcite Icon Search

Example

// Create an action button to delete features
// using the 'trash' Calcite Icon.
const deleteAction = new ActionButton({
 id: "delete-feature",
 title: "Delete Feature",
 icon: "trash"
});

id Inherited Property id String Inherited from ActionBase

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

title Inherited Property title String Inherited from ActionBase

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 Property type Stringreadonly

Specifies the type of action.

For ActionToggle the type is always "toggle".

Default Value:"toggle"

value Property value Boolean

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

Default Value:false

visible Inherited Property visible Boolean Inherited from ActionBase

Indicates if the action is visible.

Default Value:true

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
ActionToggle	Creates a deep clone of this object.	ActionToggle
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){ActionToggle}

Creates a deep clone of this object.

Returns

Type	Description
ActionToggle	A clone of the new ActionToggle instance.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");