MapQuest Advantage JavaScript API Reference Documentation

Class MQDTStyle

Object
   |
   +--MQObject
         |
         +--MQBaseDTStyle
               |
               +--MQDTStyle

class MQDTStyle
extends MQBaseDTStyle


Contains the appearance characteristics of all features for a given display type. These characteristics include the icon name, icon type (Raster or Metafile), icon visible, label visible, low scale index, and high scale index. The scale indexes indicate the range of map scales at which the display type style applies. If the user desires to create his own icon, it must be a .BMP, which is a raster image. In order to modify feature types other than points or use complex style descriptions, use the Style File Editor application to design complex styles to use with the DTStyleEx class. The Style File Editor application can export complex styles as map style strings. The DTStyleEx class has all the functionality described for DTStyle, and additionally can modify or add styles for point, line, and polygon map features using map style strings.
Defined in mqobjects.js


Field Summary
<private>  MQColorStyle m_FontBoxBkgdColor
          Value to represent the font box background color style to be used
<private>  MQColorStyle m_FontBoxOutlineColor
          Value to represent the font box outline color style to be used
<private>  MQColorStyle m_FontColor
          Value to represent the font color style to be used
<private>  MQColorStyle m_FontOutlineColor
          Value to represent the font outline color style to be used
<private>  MQFontStyle m_FontStyle
          Value to represent the font style to be used
<private>  MQSymbolType m_SymbolType
          Value to represent the symbol type to be used
   
Fields inherited from class MQObject
m_xmlDoc, m_xpath
 
Constructor Summary
MQDTStyle ()
            Constructs a new MQDTStyle object.
 
Method Summary
 String getClassName()
           Returns the text name of this class.
 MQColorStyle getFontBoxBkgdColor()
           Gets the FontBoxBkgdColor.
 int getFontBoxMargin()
           Returns the FontBoxMargin of this object.
 MQColorStyle getFontBoxOutlineColor()
           Gets the FontBoxOutlineColor.
 MQColorStyle getFontColor()
           Gets the color.
 String getFontName()
           Returns the FontName of this object.
 MQColorStyle getFontOutlineColor()
           Gets the FontOutlineColor.
 int getFontSize()
           Returns the FontSize of this object.
 MQFontStyle getFontStyle()
           Gets the font.
 boolean getLabelVisible()
           Gets the LabelVisible flag
 int getObjectVersion()
           Returns the version of this class.
 String getSymbolName()
           Returns the SymbolName of this object.
 MQSymbolType getSymbolType()
           Gets the color.
 boolean getVisible()
           Gets the Visible flag
 void loadXml(<String> strXml)
           Assigns the xml that relates to this object.
 String saveXml()
           Build an xml string that represents this object.
 void setFontBoxBkgdColor(<MQColorStyle> obj)
           Sets the FontBoxBkgdColor.
 void setFontBoxMargin(<int> val)
           Sets the FontBoxMargin of this object.
 void setFontBoxOutlineColor(<MQColorStyle> obj)
           Sets the FontBoxOutlineColor.
 void setFontColor(<MQColorStyle> obj)
           Sets the color.
 void setFontName(<String> val)
           Sets the FontName of this object.
 void setFontOutlineColor(<MQColorStyle> obj)
           Sets the FontOutlineColor.
 void setFontSize(<int> val)
           Sets the FontSize of this object.
 void setFontStyle(<MQFontStyle> obj)
           Sets the font.
 void setLabelVisible(<Boolean> bFlag)
           Sets the LabelVisible flag.
 void setSymbolName(<String> val)
           Sets the SymbolName of this object.
 void setSymbolType(<MQSymbolType> obj)
           Sets the color.
 void setVisible(<Boolean> bFlag)
           Sets the Visible flag.
 
Methods inherited from class MQBaseDTStyle
setDT, getDT, setHighScale, getHighScale, setLowScale, getLowScale, equals
   
Methods inherited from class MQObject
getM_XmlDoc, setM_XmlDoc, getM_Xpath, setM_Xpath, setProperty, getProperty, copy, internalCopy
 

Field Detail

m_FontBoxBkgdColor

<private> MQColorStyle m_FontBoxBkgdColor

m_FontBoxOutlineColor

<private> MQColorStyle m_FontBoxOutlineColor

m_FontColor

<private> MQColorStyle m_FontColor

m_FontOutlineColor

<private> MQColorStyle m_FontOutlineColor

m_FontStyle

<private> MQFontStyle m_FontStyle

m_SymbolType

<private> MQSymbolType m_SymbolType

Constructor Detail

MQDTStyle

MQDTStyle()

Method Detail

getClassName

String getClassName()

getFontBoxBkgdColor

MQColorStyle getFontBoxBkgdColor()

getFontBoxMargin

int getFontBoxMargin()

getFontBoxOutlineColor

MQColorStyle getFontBoxOutlineColor()

getFontColor

MQColorStyle getFontColor()

getFontName

String getFontName()

getFontOutlineColor

MQColorStyle getFontOutlineColor()

getFontSize

int getFontSize()

getFontStyle

MQFontStyle getFontStyle()

getLabelVisible

boolean getLabelVisible()

getObjectVersion

int getObjectVersion()

getSymbolName

String getSymbolName()

getSymbolType

MQSymbolType getSymbolType()

getVisible

boolean getVisible()

loadXml

void loadXml(<String> strXml)

saveXml

String saveXml()

setFontBoxBkgdColor

void setFontBoxBkgdColor(<MQColorStyle> obj)

setFontBoxMargin

void setFontBoxMargin(<int> val)

setFontBoxOutlineColor

void setFontBoxOutlineColor(<MQColorStyle> obj)

setFontColor

void setFontColor(<MQColorStyle> obj)

setFontName

void setFontName(<String> val)

setFontOutlineColor

void setFontOutlineColor(<MQColorStyle> obj)

setFontSize

void setFontSize(<int> val)

setFontStyle

void setFontStyle(<MQFontStyle> obj)

setLabelVisible

void setLabelVisible(<Boolean> bFlag)

setSymbolName

void setSymbolName(<String> val)

setSymbolType

void setSymbolType(<MQSymbolType> obj)

setVisible

void setVisible(<Boolean> bFlag)

MapQuest Advantage JavaScript API Reference Documentation

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