Packagecom.esri.ags.controls
Classpublic class Navigation
InheritanceNavigation Inheritance mx.containers.VBox
Implementscom.esri.ags.IMapAware

The default navigation tool for the map. By default this zoom slider will be visible, but you can change this using the Map.zoomSliderVisible property.

Table 1: Examples of default and skinned navigation tools
Default look and feel. Different zoom in and zoom icons. Vertically flipped navigation slider with zoom out on top. Showing counties etc.
Default Navigation class Styled by CSS (see sample) Upside down navigation class (see sample) Descriptive Labels

See also

com.esri.ags.controls.navigationClasses.NavigationMinusButton
com.esri.ags.controls.navigationClasses.NavigationPlusButton
com.esri.ags.controls.navigationClasses.NavigationSlider


Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined by
  
Creates a new Navigation control.
Navigation
Protected Methods
 MethodDefined by
  
addZoomInZoomOutComponents(zoomInComponent:UIComponent, zoomOutComponent:UIComponent):void
Add the zoom in and zoom out components arguments.
Navigation
  
Dispatches a NavigationEvent with ZOOM_IN type.
Navigation
  
Dispatches a NavigationEvent with ZOOM_OUT type.
Navigation
Events
 EventSummaryDefined by
   Dispatched when user clicks the zoom in button.Navigation
   Dispatched when user clicks the zoom out button.Navigation
Styles
 StyleDescriptionDefined by
  
left
Type: Number   CSS Inheritance: no
The horizontal distance in pixels from the left edge of the map. The default value is 20 pixels.
Navigation
  
navigationMinusButtonStyleName
Type: String   CSS Inheritance: no
The name of the style declaration to use for the navigation slider. The default value is undefined.
Navigation
  
navigationPlusButtonStyleName
Type: String   CSS Inheritance: no
The name of the style declaration to use for the navigation slider. The default value is undefined.
Navigation
  
navigationSliderStyleName
Type: String   CSS Inheritance: no
The name of the style declaration to use for the navigation slider. The default value is undefined.
Navigation
  
top
Type: Number   CSS Inheritance: no
The vertical distance in pixels from the top edge of the map. The default value is 20 pixels.
Navigation
Property detail
mapproperty
map:Map  [read-write]

The map reference.

Implementation
    public function get map():Map
    public function set map(value:Map):void
navigationMinusButtonClassproperty 
public var navigationMinusButtonClass:Class

A reference to the class to use for the minus button.

The default value is NavigationMinusButton.

navigationPlusButtonClassproperty 
public var navigationPlusButtonClass:Class

A reference to the class to use for the plus button.

The default value is NavigationPlusButton.

navigationSliderClassproperty 
public var navigationSliderClass:Class

A reference to the class to use for the slider.

The default value is NavigationSlider.

Constructor detail
Navigation()constructor
public function Navigation()

Creates a new Navigation control.

Method detail
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.

Parameters
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.

Event detail
zoomInevent 
Event object type: com.esri.ags.events.NavigationEvent
NavigationEvent.type property = 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.

zoomOutevent  
Event object type: com.esri.ags.events.NavigationEvent
NavigationEvent.type property = 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.