Provides the logic for the Expand widget.
Constructors
-
new ExpandViewModel(properties)
-
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 |
---|---|---|---|
Boolean | Automatically collapses the expand widget instance when the view's viewpoint updates. more details | ExpandViewModel | |
String | The name of the class. more details | Accessor | |
Boolean | Whether the widget is currently expanded or not. 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 | ExpandViewModel | |
String | The view model's state. more details | ExpandViewModel | |
MapView|SceneView | The view in which the Expand is used. more details | ExpandViewModel |
Property Details
-
autoCollapse Boolean
-
Automatically collapses the expand widget instance when the view's viewpoint updates.
- Default Value:false
-
Since: ArcGIS Maps SDK 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 Maps SDK 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-left
group, 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.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");