Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/support/actions/ActionButton"], function(ActionButton) { /* code goes here */ });
Class: esri/support/actions/ActionButton
Since: ArcGIS API for JavaScript 4.8

Action(s) used in a Popup.

See also:

Constructors

new ActionButton(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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

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

more details
more detailsActionButton
Boolean

Indicates whether this action is disabled.

more details
more detailsActionButton
String

The name of the ID assigned to this action.

more details
more detailsActionButton
String

The URL to an image that will be used to represent the action.

more details
more detailsActionButton
String

The title of the action.

more details
more detailsActionButton
String

Specifies the type of action.

more details
more detailsActionButton
Boolean

Indicates if the action is visible.

more details
more detailsActionButton

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 action's node. It can be used in conjunction with the 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.

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.

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 className property or by itself. If neither image nor className are specified, a default icon default icon will display.

title String

The title of the action.

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.

type Stringreadonly

Specifies the type of action.

Default Value:"button"
visible Boolean

Indicates if the action is visible.

Default Value:true

Method Overview

NameReturn TypeSummaryClass
ActionButton

Creates a deep clone of this object.

more details
more detailsActionButton

Method Details

clone(){ActionButton}

Creates a deep clone of this object.

Returns:
TypeDescription
ActionButtonA clone of the new ActionButton instance.

API Reference search results

NameTypeModule
Loading...