ActionButton
require(["esri/support/actions/ActionButton"], function(ActionButton) { /* code goes here */ });esri/support/actions/ActionButtonA customizable button that performs a specific action(s) used in widgets such as the Popup, LayerList, and BasemapLayerList.
Constructors
- new ActionButton(properties)
- Parameter:properties 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 | more details | ActionBase | |
| String | This adds a CSS class to the ActionButton's node. more details | more details | ActionBase | |
| String | The name of the class. more details | more details | Accessor | |
| Boolean | Indicates whether this action is disabled. more details | more details | ActionBase | |
| String | The name of the ID assigned to this action. more details | more details | ActionBase | |
| String | The URL to an image that will be used to represent the action. more details | more details | ActionButton | |
| String | The title of the action. more details | more details | ActionBase | |
| String | Specifies the type of action. more details | more details | ActionButton | |
| Boolean | Indicates if the action is visible. more details | more details | ActionBase |
Property Details
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
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 API 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.
The name of the class. The declared class name is formatted as
esri.folder.className.
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.
- image 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.
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 ActionButton the type is always "button".
- Default Value:"button"
Indicates if the action is visible.
- Default Value:true
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| ActionBase | Creates a deep clone of this object. more details | more details | ActionBase |
Method Details
Creates a deep clone of this object.
Returns:Type Description ActionBase A clone of the new ActionBase instance.