// 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");

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

Property Overview

Property Details

containerString|HTMLElement

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

declaredClassStringreadonly

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

destroyedBoolean

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

idString

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 Value	Example
vertical
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
});

viewSceneView

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

viewModelNavigationToggleViewModel autocast

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

Method Details

destroy()inherited

Destroys the widget instance.

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:

Type	Description
Boolean	Returns 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:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

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 Handle[] @type - handles to remove when 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:

Type	Description
Object	The 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.