Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Navigation
[ AMD Module Require | Legacy Module Require ]
require(["esri/toolbars/navigation"], function(Navigation) { /* code goes here */ });
Description
(Added at v1.0)
Toolbar that supports basic navigation such as pan and zoom.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new Navigation(map) | Creates a new Navigation object. |
Constants
| Name | Description |
|---|---|
PAN | Map is panned. |
ZOOM_IN | Map zooms in. |
ZOOM_OUT | Map zooms out. |
Methods
| Name | Return type | Summary |
|---|---|---|
| activate(navType) | None | Activates the toolbar for map navigation. |
| deactivate() | None | Deactivates the toolbar and reactivates map navigation. |
| isFirstExtent() | Boolean | When "true", map is at the first extent. |
| isLastExtent() | Boolean | When "true", map is at the last extent. |
| setZoomSymbol(symbol) | None | Set the SimpleFillSymbol used for the rubber band zoom. |
| zoomToFullExtent() | None | Zoom to initial extent of base layer. |
| zoomToNextExtent() | None | Zoom to next extent in extent history. |
| zoomToPrevExtent() | None | Zoom to previous extent in extent history. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| extent-history-change | Fires when the extent history changes. |
Constructor Details
Creates a new Navigation object. A Map is a required parameter.
Parameters:
< |
Required | Map the toolbar is associated with. |
Sample:
require([
"esri/map", "esri/toolbars/navigation", ...
], function(Map, Navigation, ... ) {
var map = new Map( ... );
var navToolbar = new Navigation(map);
...
});
Method Details
Activates the toolbar for map navigation. Activating the toolbar overrides default map navigation.
Parameters:
< |
Required | The navigation type. The Constants table lists valid navigation values. |
When "true", map is at the first extent.
Return type:
BooleanSample:
require([
"esri/map", "esri/toolbars/navigation", "dijit/registry", ...
], function(Map, Navigation, registry, ... ) {
var map = new Map( ... );
var navToolbar = new Navigation(map);
registry.byId("zoomprev").disabled = navToolbar.isFirstExtent();
...
});
When "true", map is at the last extent.
Return type:
BooleanSample:
require([
"esri/map", "esri/toolbars/navigation", "dijit/registry", ...
], function(Map, Navigation, registry, ... ) {
var map = new Map( ... );
var navToolbar = new Navigation(map);
registry.byId("zoomnext").disabled = navToolbar.isLastExtent();
...
});
Set the SimpleFillSymbol used for the rubber band zoom.
Parameters:
< |
Required | The SimpleFillSymbol used for the rubber band zoom. |
Sample:
require([
"esri/map", "esri/toolbars/navigation", ...
], function(Map, Navigation, ... ) {
var map = new Map( ... );
var navToolbar = new Navigation(map);
navToolbar.setZoomSymbol(zoomSymbol);
...
});
Event Details
[ On Style Events | Connect Style Event ]
Fires when the extent history changes. (Added at v3.6)
Sample:
require([
"esri/toolbars/navigation", "dijit/registry", ...
], function( Navigation, registry, ... ) {
function init(){
navToolbar = new Navigation(map);
navToolbar.on("extent-history-change", extentHistoryChangeHandler);
}
function extentHistoryChangeHandler() {
registry.byId("zoomprev").disabled = navToolbar.isFirstExtent();
registry.byId("zoomnext").disabled = navToolbar.isLastExtent();
}
...
});