| Package | com.esri.ags.toolbars |
| Class | public class Navigation |
| Inheritance | Navigation  com.esri.ags.toolbars.BaseToolbar |
See also
| Package | com.esri.ags.toolbars |
| Class | public class Navigation |
| Inheritance | Navigation com.esri.ags.toolbars.BaseToolbar |
See also
| Property | Defined by | ||
|---|---|---|---|
| isFirstExtent : Boolean [read-only]
When "true", map is at the first extent.
| Navigation | ||
| isLastExtent : Boolean [read-only]
When "true", map is at the last extent.
| Navigation | ||
| map : Map
The Map that the toolbar is associated with.
| Navigation | ||
| Method | Defined by | ||
|---|---|---|---|
|
Navigation(map:Map = null)
Creates a new Navigation object.
| Navigation | ||
|
activate(navType:String, enableGraphicsLayerMouseEvents:Boolean = false):void
Activates the toolbar for map navigation.
| Navigation | ||
|
deactivate():void
Deactivates the toolbar and reactivates map navigation.
| Navigation | ||
|
zoomToFullExtent():void
Zoom to full extent of base layer.
| Navigation | ||
|
zoomToNextExtent():void
Zoom to next extent in extent history.
| Navigation | ||
|
zoomToPrevExtent():void
Zoom to previous extent in extent history.
| Navigation | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Fires when the extent of the map has changed. | Navigation | |||
| Constant | Defined by | ||
|---|---|---|---|
| PAN : String = "pan" [static]
Map is panned.
| Navigation | ||
| ZOOM_IN : String = "zoomin" [static]
Map zooms in.
| Navigation | ||
| ZOOM_OUT : String = "zoomout" [static]
Map zooms out.
| Navigation | ||
| isFirstExtent | property |
isFirstExtent:Boolean [read-only]When "true", map is at the first extent.
This property can be used as the source for data binding.
Implementation public function get isFirstExtent():Boolean
| isLastExtent | property |
isLastExtent:Boolean [read-only]When "true", map is at the last extent.
This property can be used as the source for data binding.
Implementation public function get isLastExtent():Boolean
| map | property |
map:Map [read-write]The Map that the toolbar is associated with.
Implementation public function get map():Map
public function set map(value:Map):void
| Navigation | () | constructor |
public function Navigation(map:Map = null)Creates a new Navigation object.
Parametersmap:Map (default = null) |
| activate | () | method |
public function activate(navType:String, enableGraphicsLayerMouseEvents:Boolean = false):voidActivates the toolbar for map navigation. Activating the toolbar overrides default map navigation.
ParametersnavType:String — The navigation type - either PAN, ZOOM_IN, or ZOOM_OUT.
|
|
enableGraphicsLayerMouseEvents:Boolean (default = false)true, allows GraphicsLayer to listen for MouseEvents while toolbar is active.
|
| deactivate | () | method |
public function deactivate():voidDeactivates the toolbar and reactivates map navigation.
| zoomToFullExtent | () | method |
public function zoomToFullExtent():voidZoom to full extent of base layer.
| zoomToNextExtent | () | method |
public function zoomToNextExtent():voidZoom to next extent in extent history.
| zoomToPrevExtent | () | method |
public function zoomToPrevExtent():voidZoom to previous extent in extent history.
| extentChange | event |
com.esri.ags.events.ExtentEvent
com.esri.ags.events.ExtentEvent.EXTENT_CHANGE
Fires when the extent of the map has changed.
Defines the value of the type property of an extentChange event object.
| PAN | constant |
public static const PAN:String = "pan"Map is panned.
| ZOOM_IN | constant |
public static const ZOOM_IN:String = "zoomin"Map zooms in.
| ZOOM_OUT | constant |
public static const ZOOM_OUT:String = "zoomout"Map zooms out.