ActionToggle
require(["esri/support/actions/ActionToggle"], function(ActionToggle) { /* code goes here */ });esri/support/actions/ActionToggleA customizable toggle used in the LayerList widget that performs a specific action(s) which can be toggled on/off.
Constructors
- new ActionToggle(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Boolean | Set this property to | more details | ActionBase | |
| String | The name of the class. more details | more details | Accessor | |
| Boolean | Indicates whether this action is disabled. more details | more details | ActionBase | |
| String | The name of the ID assigned to this action. more details | more details | ActionBase | |
| String | The title of the action. more details | more details | ActionBase | |
| String | Specifies the type of action. more details | more details | ActionToggle | |
| Boolean | Indicates the value of whether the action is toggled on/off. more details | more details | ActionToggle | |
| Boolean | Indicates if the action is visible. more details | more details | ActionBase |
Property Details
Set this property to
trueto 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 tofalseto communicate to the user that the process has finished.- Default Value:false
The name of the class. The declared class name is formatted as
esri.folder.className.
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.
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 Stringreadonly
Specifies the type of action.
For ActionToggle the type is always "toggle".
- Default Value:"toggle"
- value Boolean
Indicates the value of whether the action is toggled on/off.
- Default Value:false
Indicates if the action is visible.
- Default Value:true
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| ActionToggle | Creates a deep clone of this object. more details | more details | ActionToggle |
Method Details
- clone(){ActionToggle}
Creates a deep clone of this object.
Returns:Type Description ActionToggle A clone of the new ActionToggle instance.