NavigationToggle

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

Provides two simple buttons for toggling the navigation mode of a SceneView. Note that this widget is designed only for 3D mouse interaction in a SceneView. It has no effect on touch navigation and it should not be used with 2D mouse interaction in a MapView.

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.

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. See the example below.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
// creates a new instance of the NavigationToggle widget
var navigationToggle = new NavigationToggle({
  view: view
});

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

Constructors

new NavigationToggle(properties)

Parameter:
properties Object
optional

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

Example:
// typical usage
var navigationToggle = new NavigationToggle({
  view: view
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

Sets the layout of the widget to either horizontal or vertical.

more details
more detailsNavigationToggle
SceneView

A reference to the SceneView.

more details
more detailsNavigationToggle
NavigationToggleViewModel

The view model for this widget.

more details
more detailsNavigationToggle

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClassStringreadonly inherited

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

When true, this property indicates whether the widget has been destroyed.

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

layoutString

Sets the layout of the widget to either horizontal or vertical. See the table below for a list of possible values.

Possible ValueExample
verticalnavigation-toggle
horizontalnavigation-toggle-horizontal
Default Value: vertical
Example:
// creates a new instance of the NavigationToggle widget
var navigationToggle = new NavigationToggle({
  view: view,
  layout: "horizontal"  // makes the layout horizontal
});

A reference to the SceneView. Set this to link the widget to a specific view.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the NavigationToggleViewModel class to access all properties and methods on the widget.

Method Overview

NameReturn TypeSummaryClass

Destroys the widget instance.

more details
more detailsWidget

Emits an event on the instance.

more details
more detailsWidget
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Finalizes the creation of the widget.

more details
more detailsWidget

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

more details
more detailsNavigationToggle

Method Details

destroy()inherited

Destroys the widget instance.

emit(type, event)protectedinherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses that inherit from Evented.

Parameters:
type String

The name of the event.

event Object

The event payload.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

startup()inherited

Deprecated
  • since version 4.2.

Finalizes the creation of the widget.

toggle()

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

API Reference search results

NameTypeModule

There were no match results from your search criteria.