import ActionToggle from "@arcgis/core/support/actions/ActionToggle.js";const ActionToggle = await $arcgis.import("@arcgis/core/support/actions/ActionToggle.js");- Inheritance:
- ActionToggle→
ActionBase→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.8
A customizable toggle used in the LayerList widget that performs a specific action(s) which can be toggled on/off.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
active
- Type
- 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
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.
disabled
- Type
- boolean
Indicates whether this action is disabled.
- Default value
- false
icon
- Since
- ArcGIS Maps SDK for JavaScript 4.27
Calcite icon used for the action.
- See also
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
The name of the ID assigned to this action. This is used for differentiating actions when listening to the PopupViewModel.@trigger-action event.
title
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.
uid
- Type
- string
- 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.
value
- Type
- boolean
Indicates the value of whether the action is toggled on/off.
- Default value
- false
visible
- Type
- boolean
Indicates if the action is visible.
- Default value
- true
Methods
| Method | Signature | Class |
|---|---|---|
clone(): this | |
clone
- Signature
-
clone (): this
Creates a deep clone of this object.
- Returns
- this
A clone of the new ActionToggle instance.