ExpandViewModel

AMD: require(["esri/widgets/Expand/ExpandViewModel"], (ExpandVM) => { /* code goes here */ });
ESM: import ExpandVM from "@arcgis/core/widgets/Expand/ExpandViewModel";
Class: esri/widgets/Expand/ExpandViewModel
Inheritance: ExpandViewModel Accessor
Since: ArcGIS API for JavaScript 4.3

Provides the logic for the Expand widget.

See also:

Constructors

new ExpandViewModel(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Booleanmore details

Automatically collapses the expand widget instance when the view's viewpoint updates.

more detailsExpandViewModel
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Whether the widget is currently expanded or not.

more detailsExpandViewModel
Stringmore details

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 detailsExpandViewModel
Stringmore details

The view model's state.

more detailsExpandViewModel
MapView|SceneViewmore details

The view in which the Expand is used.

more detailsExpandViewModel

Property Details

autoCollapse Boolean

Automatically collapses the expand widget instance when the view's viewpoint updates.

Default Value:false
declaredClass Stringreadonly inherited
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 String
Since: 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 the top-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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.