ExpandViewModel

require(["esri/widgets/Expand/ExpandViewModel"], function(ExpandVM) { /* code goes here */ });
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.
NameTypeSummaryClass
Boolean

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

more details
more detailsExpandViewModel
String

The name of the class.

more details
more detailsAccessor
Boolean

Whether the widget is currently expanded or not.

more details
more detailsExpandViewModel
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 detailsExpandViewModel
String

The view model's state.

more details
more detailsExpandViewModel
MapView | SceneView

The view in which the Expand is used.

more details
more detailsExpandViewModel

Property Details

autoCollapseBoolean

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

Default Value:false
declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

expandedBooleanreadonly

Whether the widget is currently expanded or not.

Default Value:false
groupString
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:
stateStringreadonly

The view model's state.

Known Values: ready | disabled

Default Value:disabled

The view in which the Expand is used.

API Reference search results

NameTypeModule

There were no match results from your search criteria.