Packagecom.esri.aws.services
Classpublic class MapLegend

MapLegend is used to create the MapLegend object within the MapImageOptions object. MapImageOptions is used with IMapImage.



Public Properties
 PropertyDefined by
  antiAliasing : String
Determines if antialiasing is used to make smoother edges for the labels and symbols.
MapLegend
  autoextend : Boolean
If true, legend automatically extends beyond the size specified in height (if needed).
MapLegend
  backgroundColor : String
The background color of the legend.
MapLegend
  columns : int
The number of columns in the legend.
MapLegend
  font : String
The font of the legend text.
MapLegend
  height : int
The height of the legend.
MapLegend
  layerFontSize : int
The size of the font for the legend layer names.
MapLegend
  splitText : String
The text that is displayed at the bottom of the column if the contents carry over to the next column.
MapLegend
  swatchHeight : int
The height of the symbol swatch in pixels.
MapLegend
  swatchWidth : int
The width of the symbol swatch in pixels.
MapLegend
  title : String
The title of the legend.
MapLegend
  titleFontSize : int
The size of the font for the legend title.
MapLegend
  valueFontSize : int
The size of the font for the legend values.
MapLegend
  width : int
The width of the legend.
MapLegend
Property detail
antiAliasingproperty
public var antiAliasing:String

Determines if antialiasing is used to make smoother edges for the labels and symbols. Valid values are "false" or "true".

The default value is "true" .

autoextendproperty 
public var autoextend:Boolean

If true, legend automatically extends beyond the size specified in height (if needed).

The default value is false.

backgroundColorproperty 
public var backgroundColor:String

The background color of the legend. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red).

The default value is "255,255,255" (white).

columnsproperty 
public var columns:int

The number of columns in the legend.

The default value is 1.

fontproperty 
public var font:String

The font of the legend text. Valid values are "Arial", "Bembo MT", "Book Antiqua", "Bookman Old Style", "Century Gothic", "Courier New", "Georgia", "Gill Sans MT", "Monotype Century Schoolbook", "Rockwell MT", "Tahoma", "Times New Roman", or "Verdana".

The default value is "Arial".

heightproperty 
public var height:int

The height of the legend. Height is in pixels. The height value is ignored if the columns value is greater than "1". (Map Image sets the best height based on the number of columns.)

The default value is 300.

layerFontSizeproperty 
public var layerFontSize:int

The size of the font for the legend layer names.

The default value is 10.

splitTextproperty 
public var splitText:String

The text that is displayed at the bottom of the column if the contents carry over to the next column.

The default value is "(cont)".

swatchHeightproperty 
public var swatchHeight:int

The height of the symbol swatch in pixels.

The default value is 14.

swatchWidthproperty 
public var swatchWidth:int

The width of the symbol swatch in pixels.

The default value is 18.

titleproperty 
public var title:String

The title of the legend.

titleFontSizeproperty 
public var titleFontSize:int

The size of the font for the legend title.

The default value is 12.

valueFontSizeproperty 
public var valueFontSize:int

The size of the font for the legend values.

The default value is 8.

widthproperty 
public var width:int

The width of the legend. Width is in pixels.

The default value is 125.