| Package | com.esri.ags.controls |
| Class | public class Navigation |
| Inheritance | Navigation mx.containers.VBox |
| Implements | com.esri.ags.IMapAware |
| Table 1: Examples of default and skinned navigation tools | |||
|---|---|---|---|
![]() |
![]() |
![]() |
![]() |
| Default Navigation class | Styled by CSS (see sample) | Upside down navigation class (see sample) | Descriptive Labels |
See also
| Property | Defined by | ||
|---|---|---|---|
| map : Map
The map reference.
| Navigation | ||
| navigationMinusButtonClass : Class
A reference to the class to use for the minus button.
| Navigation | ||
| navigationPlusButtonClass : Class
A reference to the class to use for the plus button.
| Navigation | ||
| navigationSliderClass : Class
A reference to the class to use for the slider.
| Navigation | ||
| Method | Defined by | ||
|---|---|---|---|
|
Creates a new Navigation control.
| Navigation | ||
| Method | Defined by | ||
|---|---|---|---|
|
addZoomInZoomOutComponents(zoomInComponent:UIComponent, zoomOutComponent:UIComponent):void
Add the zoom in and zoom out components arguments.
| Navigation | ||
|
dispatchZoomIn():void
Dispatches a
NavigationEvent with ZOOM_IN type. | Navigation | ||
|
dispatchZoomOut():void
Dispatches a
NavigationEvent with ZOOM_OUT type. | Navigation | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when user clicks the zoom in button. | Navigation | |||
| Dispatched when user clicks the zoom out button. | Navigation | |||
| map | property |
map:Map [read-write]The map reference.
Implementation public function get map():Map
public function set map(value:Map):void
| navigationMinusButtonClass | property |
public var navigationMinusButtonClass:ClassA reference to the class to use for the minus button.
The default value is NavigationMinusButton.
| navigationPlusButtonClass | property |
public var navigationPlusButtonClass:ClassA reference to the class to use for the plus button.
The default value is NavigationPlusButton.
| navigationSliderClass | property |
public var navigationSliderClass:ClassA reference to the class to use for the slider.
The default value is NavigationSlider.
| Navigation | () | constructor |
public function Navigation()Creates a new Navigation control.
| addZoomInZoomOutComponents | () | method |
protected function addZoomInZoomOutComponents(zoomInComponent:UIComponent, zoomOutComponent:UIComponent):void
Add the zoom in and zoom out components arguments.
This function is called at the end of the overriden createChildren,
where the zoom in and out component are created based on the navigationPlusButtonClass
and navigationMinusButtonClass properties.
The default implementation of this function adds a spacer, the zoom in button,
the zoom out buttom and then another spacer.
zoomInComponent:UIComponent — the zoom in component.
|
|
zoomOutComponent:UIComponent — the zoom out component.
|
| dispatchZoomIn | () | method |
protected function dispatchZoomIn():void
Dispatches a NavigationEvent with ZOOM_IN type.
| dispatchZoomOut | () | method |
protected function dispatchZoomOut():void
Dispatches a NavigationEvent with ZOOM_OUT type.
| zoomIn | event |
com.esri.ags.events.NavigationEvent
com.esri.ags.events.NavigationEvent.ZOOM_IN
Dispatched when user clicks the zoom in button.
Defines the value of the type property of a zoomIn event object.
| zoomOut | event |
com.esri.ags.events.NavigationEvent
com.esri.ags.events.NavigationEvent.ZOOM_OUT
Dispatched when user clicks the zoom out button.
Defines the value of the type property of a zoomOut event object.