Packagecom.afcomponents.umap.interfaces
Interfacepublic interface IMapType
ImplementorsArcGISMapType, MapType

IMapType interface describes the properties and methods that should be implemented in a Map Type object. Such objects are used by Map Tile Providers.



Public Properties
 PropertyDefined by
  caption : String
Gets or sets map types caption that will be used in the MapTypeControl.
IMapType
  copyrightMessage : String
Gets or sets the copyright message prefix.
IMapType
  errorMessage : String
Gets or sets the error message that will be displayed if tile data is unavailable.
IMapType
  layerCount : uint
[read-only] Returns the number of ITileLayer objects registered with the map type.
IMapType
  layers : Array
[read-only] Returns an Array which holds ITileLayer objects registered with the map type.
IMapType
  linkColor : uint
Gets or sets the text color of the temrs of use link.
IMapType
  maxZoom : uint
Returns maximum zoom level for the map type.
IMapType
  minZoom : uint
Returns minimum zoom level for the map type.
IMapType
  name : String
Returns the name of the map type.
IMapType
  projection : IProjection
Gets or sets the IProjection that should be used with this map type.
IMapType
  serverCount : uint
[read-only] Indicates the tile size in pixels.
IMapType
  textColor : uint
Gets or sets the text color of the copyright message.
IMapType
Public Methods
 MethodDefined by
  
addLayer(layer:ITileLayer):void
Adds new ITileLayer object to the tile layer collection.
IMapType
  
dispose():void
Releases all the resources accuired by the object.
IMapType
  
getCopyrights(bounds:LatLngBounds, zoom:Number):String
Returns an String with the copyright message for the specified view bounds and zoom level.
IMapType
Property detail
captionproperty
caption:String  [read-write]

Gets or sets map types caption that will be used in the MapTypeControl.

Implementation
    public function get caption():String
    public function set caption(value:String):void
copyrightMessageproperty 
copyrightMessage:String  [read-write]

Gets or sets the copyright message prefix.

Implementation
    public function get copyrightMessage():String
    public function set copyrightMessage(value:String):void
errorMessageproperty 
errorMessage:String  [read-write]

Gets or sets the error message that will be displayed if tile data is unavailable.

Implementation
    public function get errorMessage():String
    public function set errorMessage(value:String):void
layerCountproperty 
layerCount:uint  [read-only]

Returns the number of ITileLayer objects registered with the map type.

Implementation
    public function get layerCount():uint
layersproperty 
layers:Array  [read-only]

Returns an Array which holds ITileLayer objects registered with the map type.

Implementation
    public function get layers():Array
linkColorproperty 
linkColor:uint  [read-write]

Gets or sets the text color of the temrs of use link.

Implementation
    public function get linkColor():uint
    public function set linkColor(value:uint):void
maxZoomproperty 
maxZoom:uint  [read-write]

Returns maximum zoom level for the map type.

Implementation
    public function get maxZoom():uint
    public function set maxZoom(value:uint):void
minZoomproperty 
minZoom:uint  [read-write]

Returns minimum zoom level for the map type.

Implementation
    public function get minZoom():uint
    public function set minZoom(value:uint):void
nameproperty 
name:String  [read-write]

Returns the name of the map type.

Implementation
    public function get name():String
    public function set name(value:String):void
projectionproperty 
projection:IProjection  [read-write]

Gets or sets the IProjection that should be used with this map type. By default the MercatorProjection is used.

Implementation
    public function get projection():IProjection
    public function set projection(value:IProjection):void
serverCountproperty 
serverCount:uint  [read-only]

Indicates the tile size in pixels. Default 256.

Implementation
    public function get serverCount():uint
textColorproperty 
textColor:uint  [read-write]

Gets or sets the text color of the copyright message.

Implementation
    public function get textColor():uint
    public function set textColor(value:uint):void
Method detail
addLayer()method
public function addLayer(layer:ITileLayer):void

Adds new ITileLayer object to the tile layer collection. Please note that after adding new tile layer, minimum, maximum zoom levels, and server counter will be updated.

Parameters
layer:ITileLayer — Valid ITileLayer object.
dispose()method 
public function dispose():void

Releases all the resources accuired by the object.

getCopyrights()method 
public function getCopyrights(bounds:LatLngBounds, zoom:Number):String

Returns an String with the copyright message for the specified view bounds and zoom level.

Parameters
bounds:LatLngBounds
 
zoom:Number

Returns
String