MapQuest Advantage JavaScript API Reference Documentation

Class MQTextPrimitive

Object
   |
   +--MQObject
         |
         +--MQPrimitive
               |
               +--MQTextPrimitive

class MQTextPrimitive
extends MQPrimitive


Describes text to be placed on the map. The text is initially located by the X/Y coordinate. The coordinate is converted into a latitude/longitude point so the annotation can be placed in the same geographical location after the map is manipulated.
See:

Defined in mqobjects.js


Field Summary
<private>  MQColorStyle m_bgdColor
          Value to represent the background color style to be used
<private>  MQColorStyle m_color
          Value to represent the color style to be used
<private>  MQColorStyle m_lBoxOutlineColor
          Value to represent the box outline color style to be used
<private>  MQLatLng m_ll
          Value to represent the latitude/longitude of the upper left of the map
<private>  MQColorStyle m_lOutlineColor
          Value to represent the outline color style to be used
<private>  MQFontStyle m_nStyle
          Value to represent the font style to be used
<private>  MQPoint m_pt
          Value to represent the x/y of the upper left of the map
   
Fields inherited from class MQPrimitive
m_DrawTrigger, m_CoordinateType
   
Fields inherited from class MQObject
m_xmlDoc, m_xpath
 
Constructor Summary
MQTextPrimitive ()
            Constructs a new MQTextPrimitive object.
 
Method Summary
 MQColorStyle getBkgdColor()
           Gets the background color.
 MQColorStyle getBoxOutlineColor()
           Gets the box outline color.
 String getClassName()
           Returns the text name of this class.
 MQColorStyle getColor()
           Gets the color.
 String getFontName()
           Returns the FontName of this object.
 int getFontSize()
           Returns the FontSize of this object.
 int getMargin()
           Returns the Margin of this object.
 int getObjectVersion()
           Returns the version of this class.
 MQColorStyle getOutlineColor()
           Gets the outline color.
 MQFontStyle getStyle()
           Gets the font style.
 String getText()
           Returns the Text of this object.
 int getTextAlignment()
           Returns the TextAlignment of this object.
 MQLatLng getUpperLeftLatLng()
           Gets the latitude/longitude of the upper left of the map
 MQPoint getUpperLeftPoint()
           Gets the x/y of the upper left of the map
 int getWidth()
           Returns the Width of this object.
 void loadXml(<String> strXml)
           Assigns the xml that relates to this object.
 String saveXml()
           Build an xml string that represents this object.
 void setBkgdColor(<MQColorStyle> obj)
           Sets the background color.
 void setBoxOutlineColor(<MQColorStyle> obj)
           Sets the box outline color.
 void setColor(<MQColorStyle> obj)
           Sets the color.
 void setFontName(<String> str)
           Sets the FontName of this object.
 void setFontSize(<int> val)
           Sets the FontSize of this object.
 void setMargin(<int> val)
           Sets the Margin of this object.
 void setOutlineColor(<MQColorStyle> obj)
           Sets the outline color.
 void setStyle(<MQFontStyle> obj)
           Sets the font style.
 void setText(<String> str)
           Sets the Text of this object.
 void setTextAlignment(<int> val)
           Sets the TextAlignment of this object.
 void setUpperLeftLatLng(<MQLatLng> latLng)
           Sets the latitude/longitude of the upper left of the map
 void setUpperLeftPoint(<MQPoint> point)
           Sets the x/y of the upper left of the map
 void setWidth(<int> val)
           Sets the Width of this object.
 
Methods inherited from class MQPrimitive
getDrawTrigger, setDrawTrigger, getCoordinateType, setCoordinateType, setKey, getKey, setOpacity, getOpacity
   
Methods inherited from class MQObject
getM_XmlDoc, setM_XmlDoc, getM_Xpath, setM_Xpath, setProperty, getProperty, copy, internalCopy
 

Field Detail

m_bgdColor

<private> MQColorStyle m_bgdColor

m_color

<private> MQColorStyle m_color

m_lBoxOutlineColor

<private> MQColorStyle m_lBoxOutlineColor

m_ll

<private> MQLatLng m_ll

m_lOutlineColor

<private> MQColorStyle m_lOutlineColor

m_nStyle

<private> MQFontStyle m_nStyle

m_pt

<private> MQPoint m_pt

Constructor Detail

MQTextPrimitive

MQTextPrimitive()

Method Detail

getBkgdColor

MQColorStyle getBkgdColor()

getBoxOutlineColor

MQColorStyle getBoxOutlineColor()

getClassName

String getClassName()

getColor

MQColorStyle getColor()

getFontName

String getFontName()

getFontSize

int getFontSize()

getMargin

int getMargin()

getObjectVersion

int getObjectVersion()

getOutlineColor

MQColorStyle getOutlineColor()

getStyle

MQFontStyle getStyle()

getText

String getText()

getTextAlignment

int getTextAlignment()

getUpperLeftLatLng

MQLatLng getUpperLeftLatLng()

getUpperLeftPoint

MQPoint getUpperLeftPoint()

getWidth

int getWidth()

loadXml

void loadXml(<String> strXml)

saveXml

String saveXml()

setBkgdColor

void setBkgdColor(<MQColorStyle> obj)

setBoxOutlineColor

void setBoxOutlineColor(<MQColorStyle> obj)

setColor

void setColor(<MQColorStyle> obj)

setFontName

void setFontName(<String> str)

setFontSize

void setFontSize(<int> val)

setMargin

void setMargin(<int> val)

setOutlineColor

void setOutlineColor(<MQColorStyle> obj)

setStyle

void setStyle(<MQFontStyle> obj)

setText

void setText(<String> str)

setTextAlignment

void setTextAlignment(<int> val)

setUpperLeftLatLng

void setUpperLeftLatLng(<MQLatLng> latLng)

setUpperLeftPoint

void setUpperLeftPoint(<MQPoint> point)

setWidth

void setWidth(<int> val)

MapQuest Advantage JavaScript API Reference Documentation

Documentation generated by JSDoc on Tue Oct 16 08:04:12 2007