Packagecom.mapquest
Classpublic class MapState
InheritanceMapState Inheritance MQObject

Defines the characteristics of a map. It includes such information as the map name, the coverage name, the latitude/longitude of the map Center, the map scale, and the image size.

See also

LatLng
Point

Public Properties
 PropertyDefined by
 InheritedCLASS_NAME : String = "MQObject"
[static]
MQObject
Protected Properties
 PropertyDefined by
 InheritedobjectVersion : Number = 0
Value to represent the version of this object
MQObject
 Inheritedxml : XML = null
MQObject
 Inheritedxpath : String
MQObject
Public Methods
 MethodDefined by
  
MapState()
Constructs a new MapState object.
MapState
  
equals(comparator:MapState):Boolean
Compares this object to the specified object.
MapState
  
getCenter():LatLng
Returns the Center point of the map associated with this MapState object.
MapState
  
getClassName():String
Returns the text name of this class.
MapState
  
getCoverageName():String
Returns the coverage name of the map associated with this MapState object.
MapState
  
getHeightInches():Number
Returns the height of the generated map in inches.
MapState
  
getHeightPixels(dpi:int = 0):int
Returns the height of the generated map in pixels.
MapState
  
getMapName():String
Returns the map name of the map associated with this MapState object.
MapState
  
getMapScale():int
Returns the scale of the map associated with this MapState object.
MapState
  
getObjectVersion():Number
Returns the version of this class.
MapState
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getWidthInches():Number
Returns the width of the generated map in inches.
MapState
  
getWidthPixels(dpi:int = 0):Number
Returns the width of the generated map in pixels.
MapState
  
initObject():void
Initializes object.
MapState
 Inherited
internalCopy(obj:MQObject):MQObject
Create a copy of this object.
MQObject
 Inherited
internalCopyXML(obj:MQObject):XML
MQObject
 Inherited
internalCopyXMLx(obj:MQObject):String
MQObject
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
MapState
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
MapState
  
setCenter(latLng:LatLng):void
Sets the Center point of the map associated with this MapState object.
MapState
  
setCoverageName(strCovId:String):void
Sets the coverage name for the map associated with this MapState object.
MapState
  
setHeightInches(dHeight:Number):void
Sets the height of the generated map in inches.
MapState
  
setHeightPixels(iHeight:int, dpi:int = 0):void
Sets the height of the generated map in pixels.
MapState
  
setMapName(strName:String):void
Sets the map name of the map associated with this MapState object.
MapState
  
setMapScale(nNewScale:int):void
Sets the scale of the map associated with this MapState object.
MapState
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setWidthInches(dWidth:Number):void
Sets the width of the generated map in inches.
MapState
  
setWidthPixels(iWidth:int, dpi:int = 0):void
Sets the width of the generated map in pixels.
MapState
 Inherited
setXpath(xpath:String):void
Sets the m_xpath object.
MQObject
 Inherited
writeExternal(output:IDataOutput):void
MQObject
Protected Methods
 MethodDefined by
 Inherited
getXML():XML
Returns the m_xmlDoc object.
MQObject
 Inherited
getXpath():String
Returns the xpath string.
MQObject
 Inherited
setXML(xml:XML):void
Sets the m_xmlDoc object.
MQObject
Constructor detail
MapState()constructor
public function MapState()

Constructs a new MapState object.

Method detail
equals()method
public function equals(comparator:MapState):Boolean

Compares this object to the specified object. The result is true if and only if the argument is not null and is a MapState object that has same attributes as this object.

Parameters
comparator:MapState — {MapState} comparator the object to compare this MapState against.

Returns
Boolean — true if the MapState objects are equal; false otherwise.
getCenter()method 
public function getCenter():LatLng

Returns the Center point of the map associated with this MapState object.

Returns
LatLng — The Center point of this MapState object.
getClassName()method 
public override function getClassName():String

Returns the text name of this class.

Returns
String — The text name of this class.
getCoverageName()method 
public function getCoverageName():String

Returns the coverage name of the map associated with this MapState object.

Returns
String — The coverage name of this MapState object.
getHeightInches()method 
public function getHeightInches():Number

Returns the height of the generated map in inches.

Returns
Number — the height of the generated map in inches.
getHeightPixels()method 
public function getHeightPixels(dpi:int = 0):int

Returns the height of the generated map in pixels.

Parameters
dpi:int (default = 0) — dpi int value specifying the DPI used to convert image size from inches to pixels.

Returns
int
getMapName()method 
public function getMapName():String

Returns the map name of the map associated with this MapState object.

Returns
String — The map name of the map associated with this MapState object.
getMapScale()method 
public function getMapScale():int

Returns the scale of the map associated with this MapState object.

Returns
int — The scale of this MapState object.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
getWidthInches()method 
public function getWidthInches():Number

Returns the width of the generated map in inches.

Returns
Number — the width of the generated map in inches.
getWidthPixels()method 
public function getWidthPixels(dpi:int = 0):Number

Returns the width of the generated map in pixels.

Parameters
dpi:int (default = 0) — dpi int value specifying the DPI used to convert image size from inches to pixels.

Returns
Number — the width of the generated map in pixels.
initObject()method 
public function initObject():void

Initializes object.

loadXml()method 
public override function loadXml(xmlPrm:XML):void

Assigns the xml that relates to this object.

Parameters
xmlPrm:XML — the xml to be assigned.
saveXml()method 
public override function saveXml():XML

Build xml that represents this object. Because this is a complex object we need to completely rebuild the xml.

Returns
XML — The xml.
setCenter()method 
public function setCenter(latLng:LatLng):void

Sets the Center point of the map associated with this MapState object.

Parameters
latLng:LatLng — latLng The Center point for the map associated with this MapState object.
setCoverageName()method 
public function setCoverageName(strCovId:String):void

Sets the coverage name for the map associated with this MapState object.

Parameters
strCovId:String — strCovId The coverage name of the map associated with this MapState object.
setHeightInches()method 
public function setHeightInches(dHeight:Number):void

Sets the height of the generated map in inches.

Parameters
dHeight:Number — dHeight double value specifying the height of the map in inches.
setHeightPixels()method 
public function setHeightPixels(iHeight:int, dpi:int = 0):void

Sets the height of the generated map in pixels.

Parameters
iHeight:int — iHeight int value specifying the height of the map in pixels.
 
dpi:int (default = 0) — dpi int value specifying the DPI of the image, used to convert from inches to pixels.
setMapName()method 
public function setMapName(strName:String):void

Sets the map name of the map associated with this MapState object.

Parameters
strName:String — strName The map name for the map associated with this MapState object.
setMapScale()method 
public function setMapScale(nNewScale:int):void

Sets the scale of the map associated with this MapState object.

Parameters
nNewScale:int — nNewScale The new scale value for the map associated with this MapState object.
setWidthInches()method 
public function setWidthInches(dWidth:Number):void

Sets the width of the generated map in inches.

Parameters
dWidth:Number — dWidth double value specifying the width of the map in inches.
setWidthPixels()method 
public function setWidthPixels(iWidth:int, dpi:int = 0):void

Sets the width of the generated map in pixels.

Parameters
iWidth:int — iWidth int value specifying the width of the map in pixels.
 
dpi:int (default = 0) — dpi int value specifying the DPI of the image, used to convert from inches to pixels.