NavigationToggleViewModel

require(["esri/widgets/NavigationToggle/NavigationToggleViewModel"], function(NavigationToggleVM) { /* code goes here */ });
Class: esri/widgets/NavigationToggle/NavigationToggleViewModel
Inheritance: NavigationToggleViewModel Accessor
Since: ArcGIS API for JavaScript 4.0

Provides the logic for the NavigationToggle widget, which provides two simple buttons for toggling the navigation mode of a SceneView. Note that this is not designed for 2D mouse interaction in a MapView, nor for touch navigation.

navigation-toggle

The default navigation mode of the SceneView is always pan. The various mouse interations of this mode are outlined here. The alternate navigation mode to toggle to is rotate. This allows the user to rotate the view with a mouse drag and pan the view with a right-click and drag gesture.

See also:
Example:
// creates a new instance of the NavigationToggle
let navigationToggle = new NavigationToggle({
  viewModel: {
    view: view
  },
  layout: "horizontal"
});

// and adds it to the top right of the view
view.ui.add(navigationToggle, "top-right");

Constructors

new NavigationToggleViewModel(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
String

The name of the class.

more details
more detailsAccessor
String

The navigation mode of the view.

more details
more detailsNavigationToggleViewModel
String

The state of the widget.

more details
more detailsNavigationToggleViewModel
SceneView

The view associated with the widget.

more details
more detailsNavigationToggleViewModel

Property Details

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.

The navigation mode of the view. See the table below for a list of possible values.

Possible Value Description
pan The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.
rotate The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.

Possible Values:"pan"|"rotate"

Default Value:pan
state Stringreadonly

The state of the widget.

Possible Values:"disabled"|"ready"

Default Value:disabled
view SceneView

The view associated with the widget.

Method Overview

Name Return Type Summary Class

Toggles the navigation mode of the view from pan to rotate or vice versa.

more details
more detailsNavigationToggleViewModel

Method Details

toggle()

Toggles the navigation mode of the view from pan to rotate or vice versa.