| Package | com.esri.ags.tools |
| Class | public class NavigationTool |
| Inheritance | NavigationTool  com.esri.ags.tools.BaseTool |
See also
| Property | Defined By | ||
|---|---|---|---|
| isFirstExtent : Boolean [read-only]
When "true", map is at the first extent. | NavigationTool | ||
| isLastExtent : Boolean [read-only]
When "true", map is at the last extent. | NavigationTool | ||
| map : Map [override]
The Map that the NavigationTool is associated with. | NavigationTool | ||
| Method | Defined By | ||
|---|---|---|---|
NavigationTool(map:Map = null)
Creates a new NavigationTool object. | NavigationTool | ||
activate(navType:String, enableGraphicsLayerMouseEvents:Boolean = false):void
Activates a specific navigation type (pan, zoom in or zoom out). | NavigationTool | ||
deactivate():void
Deactivates the tool and reactivates default map navigation behavior. | NavigationTool | ||
zoomToFullExtent():void Deprecated Since ArcGIS API for Flex 2.3: Please Use Map.zoomToInitialExtent()
Zoom to full extent of base layer. | NavigationTool | ||
zoomToNextExtent():void
Zoom to next extent in extent history. | NavigationTool | ||
zoomToPrevExtent():void
Zoom to previous extent in extent history. | NavigationTool | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Fires when the extent of the map has changed. | NavigationTool | |||
| Constant | Defined By | ||
|---|---|---|---|
| PAN : String = pan [static]
Map is panned. | NavigationTool | ||
| ZOOM_IN : String = zoomin [static]
Map zooms in. | NavigationTool | ||
| ZOOM_OUT : String = zoomout [static]
Map zooms out. | NavigationTool | ||
| 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.
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.
public function get isLastExtent():Boolean| map | property |
map:Map[override] The Map that the NavigationTool is associated with.
public function get map():Map public function set map(value:Map):void| NavigationTool | () | Constructor |
public function NavigationTool(map:Map = null)Creates a new NavigationTool object.
Parametersmap:Map (default = null) |
| activate | () | method |
public function activate(navType:String, enableGraphicsLayerMouseEvents:Boolean = false):voidActivates a specific navigation type (pan, zoom in or zoom out). Activating the tool overrides default map navigation.
Parameters
navType:String — The navigation type - either PAN, ZOOM_IN, or ZOOM_OUT.
| |
enableGraphicsLayerMouseEvents:Boolean (default = false)true, allows GraphicsLayer to listen for MouseEvents while tool is active.
|
| deactivate | () | method |
public function deactivate():voidDeactivates the tool and reactivates default map navigation behavior.
| 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.ExtentEventcom.esri.ags.events.ExtentEvent.EXTENT_CHANGEFires when the extent of the map has changed.
Defines the value of thetype property of an extentChange event object.
| PAN | Constant |
public static const PAN:String = panMap is panned.
| ZOOM_IN | Constant |
public static const ZOOM_IN:String = zoominMap zooms in.
| ZOOM_OUT | Constant |
public static const ZOOM_OUT:String = zoomoutMap zooms out.