require(["esri/support/actions/ActionToggle"], (ActionToggle) => { /* code goes here */ });
import ActionToggle from "@arcgis/core/support/actions/ActionToggle.js";
esri/support/actions/ActionToggle
A customizable toggle used in the LayerList widget that performs a specific action(s) which can be toggled on/off.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Set this property to | ActionBase | ||
The name of the class. | Accessor | ||
Indicates whether this action is disabled. | ActionBase | ||
Calcite icon used for the action. | ActionBase | ||
The name of the ID assigned to this action. | ActionBase | ||
The title of the action. | ActionBase | ||
Specifies the type of action. | ActionToggle | ||
Indicates the value of whether the action is toggled on/off. | ActionToggle | ||
Indicates if the action is visible. | ActionBase |
Property Details
-
active
InheritedPropertyactive 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 tofalse
to communicate to the user that the process has finished.- Default Value:false
-
disabled
InheritedPropertydisabled Boolean
Inherited from ActionBase -
Indicates whether this action is disabled.
- Default Value:false
-
icon
InheritedPropertyicon String
Inherited from ActionBaseSince: ArcGIS Maps SDK for JavaScript 4.27ActionBase since 4.8, icon added at 4.27. -
Calcite icon used for the action.
- Default Value:null
- See also
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
InheritedPropertyid 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
InheritedPropertytitle 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
type Stringreadonly
-
Specifies the type of action.
For ActionToggle the type is always "toggle".
- Default Value:"toggle"
-
value
value Boolean
-
Indicates the value of whether the action is toggled on/off.
- Default Value:false
-
visible
InheritedPropertyvisible Boolean
Inherited from ActionBase -
Indicates if the action is visible.
- Default Value:true
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of this object. | ActionToggle | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
clone(){ActionToggle}
-
Creates a deep clone of this object.
ReturnsType Description ActionToggle A clone of the new ActionToggle instance.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");