Packagecom.esri.bacore.thematicmapping
Classpublic class GeographyLevelInfo
InheritanceGeographyLevelInfo Inheritance Object

The GeographyLevelInfo class provides a collection of geography layers representing the geography level in descending order of scale values.



Public Properties
 PropertyDefined By
  aliasName : String
Geography level long alias name.
GeographyLevelInfo
  layersCount : int
[read-only] The number of geography layers of this level.
GeographyLevelInfo
  name : String
[read-only] Geography level short name.
GeographyLevelInfo
Public Methods
 MethodDefined By
  
GeographyLevelInfo(name:String, aliasName:String, layers:Array)
Creates a new instance of the GeographyLevelInfo class.
GeographyLevelInfo
  
Gets geography layer by index.
GeographyLevelInfo
  
isAvailable(mapScale:Number):Boolean
Tests the geography level to be shown for the given map scale.
GeographyLevelInfo
  
Selects a layer whose scale best matches to the given scale parameter value.
GeographyLevelInfo
  
toString():String
Returns this geography level string representation for GUI controls.
GeographyLevelInfo
Property Detail
aliasNameproperty
aliasName:String

Geography level long alias name.


Implementation
    public function get aliasName():String
    public function set aliasName(value:String):void
layersCountproperty 
layersCount:int  [read-only]

The number of geography layers of this level.


Implementation
    public function get layersCount():int
nameproperty 
name:String  [read-only]

Geography level short name.


Implementation
    public function get name():String
Constructor Detail
GeographyLevelInfo()Constructor
public function GeographyLevelInfo(name:String, aliasName:String, layers:Array)

Creates a new instance of the GeographyLevelInfo class.

Parameters
name:String
 
aliasName:String
 
layers:Array
Method Detail
getLayerByIndex()method
public function getLayerByIndex(index:int):IGeographyLayerInfo

Gets geography layer by index.

Parameters

index:int — Zero-based index of layer.

Returns
IGeographyLayerInfo — Required geography layer.
isAvailable()method 
public function isAvailable(mapScale:Number):Boolean

Tests the geography level to be shown for the given map scale.

Parameters

mapScale:Number — Required map scale.

Returns
Boolean — true if this geography level is available for the given map scale.
selectBestLayer()method 
public function selectBestLayer(scale:Number):IGeographyLayerInfo

Selects a layer whose scale best matches to the given scale parameter value.

Parameters

scale:Number — A required scaling.

Returns
IGeographyLayerInfo — The best matching layer or null.
toString()method 
public function toString():String

Returns this geography level string representation for GUI controls.

Returns
String — Alias name value.