com.esri.ags.components.ScaleBar

Package	com.esri.ags.components
Class	public class ScaleBar
Inheritance	ScaleBar spark.components.supportClasses.SkinnableComponent

The Scale Bar component for the Map. By default the scale bar will be visible, but you can change this using the Map.scaleBarVisible property.

Sample image of the scale bar: Scale bar showing miles and km

See also

com.esri.ags.Map.scaleBarVisible

Public Properties

	Property		Defined By
		lengthMetric : Number The length in pixels of the metric scale bar.	ScaleBar
		lengthUS : Number The length in pixels of the US scale bar.	ScaleBar
		map : Map The Map that the ScaleBar is associated with.	ScaleBar
		textMetric : String The text to display the 'km' or 'm' value.	ScaleBar
		textUS : String The text to display the 'miles' or 'feet' value.	ScaleBar

Public Methods

	Method		Defined By
		ScaleBar() Creates a new ScaleBar component.	ScaleBar

Property Detail

lengthMetric

property

lengthMetric:Number

The length in pixels of the metric scale bar.

This property can be used as the source for data binding.

Implementation
public function get lengthMetric():Number
public function set lengthMetric(value:Number):void

lengthUS

property

lengthUS:Number

The length in pixels of the US scale bar.

This property can be used as the source for data binding.

Implementation
public function get lengthUS():Number
public function set lengthUS(value:Number):void

map

property

map:Map

The Map that the ScaleBar is associated with. When the scale bar class is defined in a Map instance, then the map instance is 'injected' via the setter on the newly created scale bar instance.

This property can be used as the source for data binding.

Implementation
public function get map():Map
public function set map(value:Map):void

textMetric

property

textMetric:String

The text to display the 'km' or 'm' value.

This property can be used as the source for data binding.

Implementation
public function get textMetric():String
public function set textMetric(value:String):void

textUS

property

textUS:String

The text to display the 'miles' or 'feet' value.

This property can be used as the source for data binding.

Implementation
public function get textUS():String
public function set textUS(value:String):void

Constructor Detail

ScaleBar

()

Constructor

public function ScaleBar()

Creates a new ScaleBar component.

Wed Nov 30 2011, 04:19 PM -08:00