require(["esri/widgets/Expand/ExpandViewModel"], (ExpandVM) => { /* code goes here */ });
import ExpandVM from "@arcgis/core/widgets/Expand/ExpandViewModel.js";
esri/widgets/Expand/ExpandViewModel
Provides the logic for the Expand widget.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
Automatically collapses the expand widget instance when the view's viewpoint updates. | ExpandViewModel | ||
The name of the class. | Accessor | ||
Whether the widget is currently expanded or not. | ExpandViewModel | ||
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. | ExpandViewModel | ||
The view model's state. | ExpandViewModel | ||
The view in which the Expand is used. | ExpandViewModel |
Property Details
-
autoCollapse
PropertyautoCollapse Boolean -
Automatically collapses the expand widget instance when the view's viewpoint updates.
- Default Value:false
-
expanded
Propertyexpanded Boolean -
Whether the widget is currently expanded or not.
- Default Value:false
-
group
Propertygroup StringSince: ArcGIS Maps SDK for JavaScript 4.6ExpandViewModel since 4.3, group added at 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
Propertystate Stringreadonly -
The view model's state.
Possible Values:"ready" |"disabled"
- Default Value:"disabled"
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");