ExpandViewModel
require(["esri/widgets/Expand/ExpandViewModel"], function(ExpandVM) { /* code goes here */ });esri/widgets/Expand/ExpandViewModelProvides the logic for the Expand widget.
Constructors
- new ExpandViewModel(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 | Automatically collapses the expand widget instance when the view's viewpoint updates. more details | more details | ExpandViewModel | |
| String | The name of the class. more details | more details | Accessor | |
| Boolean | Whether the widget is currently expanded or not. more details | more details | ExpandViewModel | |
| String | This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. more details | more details | ExpandViewModel | |
| String | The view model's state. more details | more details | ExpandViewModel | |
| MapView|SceneView | The view in which the Expand is used. more details | more details | ExpandViewModel |
Property Details
- autoCollapse Boolean
Automatically collapses the expand widget instance when the view's viewpoint updates.
- Default Value:false
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- expanded Boolean
Whether the widget is currently expanded or not.
- Default Value:false
- group StringSince: ArcGIS API for JavaScript 4.6
This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. For auto collapsing to take effect, all instances of the group must be included in the view.ui.
For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a group called
top-left. If one Expand instance is expanded and the user clicks on a different instance in thetop-leftgroup, then the first instance is collapsed, allowing the content of the second instance to be fully visible.- See also:
- state Stringreadonly
The view model's state.
Possible Values:"ready"|"disabled"
- Default Value:disabled
The view in which the Expand is used.