• esri/support

ActionBase

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

Actions are customizable behavior which can be executed in certain widgets such as Popups, a BasemapLayerList, or a LayerList.

The ActionBase class is a read-only base class which has no constructor.

See also

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
Boolean

Set this property to true to display a spinner icon.

more details
ActionBase
String

This adds a CSS class to the ActionButton's node.

more details
ActionBase
String

The name of the class.

more details
Accessor
Boolean

Indicates whether this action is disabled.

more details
ActionBase
String

The name of the ID assigned to this action.

more details
ActionBase
String

The title of the action.

more details
ActionBase
String

Specifies the type of action.

more details
ActionBase
Boolean

Indicates if the action is visible.

more details
ActionBase

Property Details

active Boolean

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
className String

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 default zoom-to action in Popup uses the font esri-icon-zoom-in-magnifying-glass.

declaredClass Stringreadonly inherited

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

disabled Boolean

Indicates whether this action is disabled.

Default Value:false
id String

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

title String

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 String

Specifies the type of action. Choose between "button" or "toggle".

Possible Values:"button"|"slider"|"toggle"

Default Value:null
visible Boolean

Indicates if the action is visible.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
ActionBase

Creates a deep clone of this object.

more details
ActionBase
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(){ActionBase}

Creates a deep clone of this object.

Returns
Type Description
ActionBase A clone of the new ActionBase instance.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");

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