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
Booleanmore details

Set this property to true to display a spinner icon.

more detailsActionBase
Stringmore details

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

more detailsActionBase
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates whether this action is disabled.

more detailsActionBase
Stringmore details

The name of the ID assigned to this action.

more detailsActionBase
Stringmore details

The title of the action.

more detailsActionBase
Stringmore details

Specifies the type of action.

more detailsActionBase
Booleanmore details

Indicates if the action is visible.

more detailsActionBase

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

Name Return Type Summary Class
ActionBasemore details

Creates a deep clone of this object.

more detailsActionBase

Method Details

clone(){ActionBase}

Creates a deep clone of this object.

Returns:
Type Description
ActionBase A clone of the new ActionBase instance.

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