ActionButton | References | ArcGIS Maps SDK for JavaScript

import ActionButton from "@arcgis/core/support/actions/ActionButton.js";

Inheritance:: ActionButton→ActionBase→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.8

A customizable button that performs a specific action(s) used in widgets such as the Popup, LayerList, and BasemapLayerList.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ActionButtonProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`active` inherited	`boolean`	ActionBase
`className` inherited	`string \| null \| undefined`	ActionBase
`declaredClass` readonly inherited	`string`	Accessor
`disabled` inherited	`boolean`	ActionBase
`icon` inherited	`Icon["icon"] \| null \| undefined`	ActionBase
`id` inherited	`string \| null \| undefined`	ActionBase
`image`	`string \| null \| undefined`
`title` inherited	`string \| null \| undefined`	ActionBase
`type` readonly	`"button"`
`uid` readonly inherited	`string`	IdentifiableMixin
`visible` inherited	`boolean`	ActionBase

active

inherited Property

Type: boolean

Inherited from: ActionBase

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

inherited Property

Type: string | null | undefined

Inherited from: ActionBase

This adds a CSS class to the ActionButton's node. It can be used in conjunction with its ActionButton.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 Maps SDK 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

readonlyinherited Property

Type: string

Inherited from: Accessor

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

disabled

inherited Property

Type: boolean

Inherited from: ActionBase

Indicates whether this action is disabled.

Default value: false

icon

inherited Property

Type: Icon["icon"] | null | undefined

Inherited from: ActionBase

Since: ArcGIS Maps SDK for JavaScript 4.27

Calcite icon used for the action.

See also

Calcite Icon Search

Example

// Create an action button to delete features
// using the 'trash' Calcite Icon.
const deleteAction = new ActionButton({
 id: "delete-feature",
 title: "Delete Feature",
 icon: "trash"
});

id

inherited Property

Type: string | null | undefined

Inherited from: ActionBase

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

image

Property

Type: string | null | undefined

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 will display.

title

inherited Property

Type: string | null | undefined

Inherited from: ActionBase

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

readonly Property

Type: "button"

Specifies the type of action.

Default value: "button"

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

Since: ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

visible

inherited Property

Type: boolean

Inherited from: ActionBase

Indicates if the action is visible.

Default value: true

Methods

Method	Signature	Class
`clone`	`clone(): this`

clone

Method

Signature: clone (): this

Creates a deep clone of this object.

Returns: this
A clone of the new ActionButton instance.