ActionToggle
require(["esri/support/actions/ActionToggle"], function(ActionToggle) { /* code goes here */ });esri/support/actions/ActionToggleActions used in Popup and LayerList. Use this when working with actions you wish to display as a toggle.
- See also:
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 | Indicates whether the action is currently active. more details | more details | ActionToggle | |
| String | Adds a CSS class to the action's node. more details | more details | ActionToggle | |
| Boolean | Indicates whether this action is disabled. more details | more details | ActionToggle | |
| String | The name of the ID assigned to this action. more details | more details | ActionToggle | |
| String | The title of the action. more details | more details | ActionToggle | |
| String | Specifies the type of action. more details | more details | ActionToggle | |
| Boolean | Indicates if the action is visible. more details | more details | ActionToggle |
Property Details
- activeBoolean
Indicates whether the action is currently active.
- Default Value:false
- classNameString
Adds a CSS class to the action's node. Can be used in conjunction with the
imageproperty 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 withesri-. For example, the defaultzoom-toaction in Popup uses the fontesri-icon-zoom-in-magnifying-glass.
- disabledBoolean
Indicates whether this action is disabled.
- Default Value:false
- idString
The name of the ID assigned to this action. This is used for differentiating actions when listening to the trigger-action event.
- titleString
The title of the action.
For popups: When there are fewer than three actions defined in a popup, this text is displayed to the right of the icon or image representing the action. If there are three or more actions in the popup, then this text is used as a tooltip on the action.
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
- typeString
Specifies the type of action. Choose between "button" or "toggle". Currently, these two are the only supported types. A "slider" type will follow-up in a future release.
- Default Value:null
- visibleBoolean
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.