Skip To ContentArcGIS for DevelopersSign In Dashboard

ActionBase

Class: esri/support/actions/ActionBase
Inheritance: ActionBase Accessor
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.
NameTypeSummaryClass
Boolean

Set this property to true to display a spinner icon.

more details
more detailsActionBase
String

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

more details
more detailsActionBase
String

The name of the class.

more details
more detailsAccessor
Boolean

Indicates whether this action is disabled.

more details
more detailsActionBase
String

The name of the ID assigned to this action.

more details
more detailsActionBase
String

The title of the action.

more details
more detailsActionBase
String

Specifies the type of action.

more details
more detailsActionBase
Boolean

Indicates if the action is visible.

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

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

NameReturn TypeSummaryClass
ActionBase

Creates a deep clone of this object.

more details
more detailsActionBase

Method Details

clone(){ActionBase}

Creates a deep clone of this object.

Returns:
TypeDescription
ActionBaseA clone of the new ActionBase instance.

API Reference search results

NameTypeModule
Loading...