require(["esri/support/actions/ActionButton"], (ActionButton) => { /* code goes here */ });
import ActionButton from "@arcgis/core/support/actions/ActionButton.js";
esri/support/actions/ActionButton
A customizable button that performs a specific action(s) used in widgets such as the Popup, LayerList, and BasemapLayerList.
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 |
|---|---|---|---|
| Boolean | Set this property to | ActionBase | |
| String | This adds a CSS class to the ActionButton's node. | 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 URL to an image that will be used to represent the action. | ActionButton | |
| String | The title of the action. | ActionBase | |
| String | Specifies the type of action. | ActionButton | |
| Boolean | Indicates if the action is visible. | ActionBase |
Property Details
-
active
InheritedPropertyactive BooleanInherited from ActionBase -
Set this property to
trueto 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 tofalseto communicate to the user that the process has finished.- Default Value:false
-
className
InheritedPropertyclassName StringInherited from ActionBase -
This adds a CSS class to the ActionButton's node. It can be used in conjunction with its image property or by itself. Any icon font may be used in this property. The Esri Icon Font is automatically made available via the ArcGIS Maps SDK for JavaScript for you to use in styling custom actions. To use one of these provided icon fonts, you must prefix the class name with
esri-. For example, the defaultzoom-toaction in Popup uses the fontesri-icon-zoom-in-magnifying-glass.
-
disabled
InheritedPropertydisabled BooleanInherited from ActionBase -
Indicates whether this action is disabled.
- Default Value:false
-
icon
InheritedPropertyicon StringInherited 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 StringInherited from ActionBase -
The name of the ID assigned to this action. This is used for differentiating actions when listening to the trigger-action event.
-
image
Propertyimage String -
The URL to an image that will be used to represent the action. This property will be used as a background image for the node. It may be used in conjunction with the
classNameproperty or by itself. If neitherimagenorclassNameare specified, a default icon
will display.
-
title
InheritedPropertytitle StringInherited 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
Propertytype Stringreadonly -
Specifies the type of action.
For ActionButton the type is always "button".
- Default Value:"button"
-
visible
InheritedPropertyvisible BooleanInherited 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 | ||
| ActionButton | Creates a deep clone of this object. | ActionButton | |
| Boolean | 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
Methodclone(){ActionButton} -
Creates a deep clone of this object.
ReturnsType Description ActionButton A clone of the new ActionButton 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 trueif 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");