Packagecom.esri.aws.services
Classpublic class MapImageOptions

MapImageOptions is used to set the specifics of an IMapImage request.

See also

IMapImage


Public Properties
 PropertyDefined by
  backgroundColor : String
The background color of the map image.
MapImageOptions
  dataSource : String
The name of the data source to use for mapping.
MapImageOptions
  displayLayers : Array
The map layers that are visible.
MapImageOptions
  height : int
The height of the requested map
MapImageOptions
  mapImageFormat : String
The image format of the map.
MapImageOptions
  mapLegend : MapLegend
The legend for the map.
MapImageOptions
  outputCoordSys : CoordSys
The coordinate system of the output map.
MapImageOptions
  returnLayers : Boolean = false
If true, LayerInfo objects are returned.
MapImageOptions
  styleSheet : String
The style sheet to apply to the map.
MapImageOptions
  width : int
The width of the requested map
MapImageOptions
Property detail
backgroundColorproperty
public var backgroundColor:String

The background color of the map image. Valid format is an R,G,B string with each value between 0 and 255 (for example, "255,0,0" is red). To set a transparent background, include "transparent:" at the beginning of your R,G,B value (for example, "transparent:255,0,0").

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

dataSourceproperty 
public var dataSource:String

The name of the data source to use for mapping. Required. See Map Image data sources for valid values (use the name in parenthesis.)

displayLayersproperty 
public var displayLayers:Array

The map layers that are visible. The default visible layers on the map image are displayed if displayLayers is not set.

heightproperty 
public var height:int

The height of the requested map

mapImageFormatproperty 
public var mapImageFormat:String

The image format of the map. Valid values are "jpg", "gif", "png", "png8", "svg", or "swf" (Flash). Default value is "jpg" for imagery maps and "gif" for road maps.

mapLegendproperty 
public var mapLegend:MapLegend

The legend for the map.

outputCoordSysproperty 
public var outputCoordSys:CoordSys

The coordinate system of the output map. Default value is the projection of the input map extent or center point.

returnLayersproperty 
public var returnLayers:Boolean = false

If true, LayerInfo objects are returned.

The default value is false.

styleSheetproperty 
public var styleSheet:String

The style sheet to apply to the map. Valid values are "classicEuropean", "coolSteel", "grayScale", "neutral", and "tangerine".

The default value is "neutral".

widthproperty 
public var width:int

The width of the requested map