Packagecom.esri.bacore
Classpublic class RenderingParameters
InheritanceRenderingParameters Inheritance Object
Implements IJsonObject

The RenderingParameters class provides parameters for rendering a task output as an image.

This class is only used in the Business Analyst Server API for Flex. The imageDescription and mapDescription properties are optional parameters. If the mapDescription is missing, the default map will be used. If the imageDescription is missing, default values are used for rendering the image.

See also

AnalysisParameters
AnalysisAndReportParameters

Public Properties
 PropertyDefined By
  imageDescription : ImageDescription
Settings of the image to be generated.
RenderingParameters
  mapDescription : String
Settings of a map of the current document which will be used for rendering a layer to image.
RenderingParameters
  zoomToLayer : Boolean
Either zoom the map to layer before rendering to image or not.
RenderingParameters
Public Methods
 MethodDefined By
  
RenderingParameters(imageDescription:ImageDescription = null, mapDescription:String = null)
Creates a new instance of the RenderingParameters class.
RenderingParameters
Property Detail
imageDescriptionproperty
imageDescription:ImageDescription

Settings of the image to be generated.


Implementation
    public function get imageDescription():ImageDescription
    public function set imageDescription(value:ImageDescription):void
mapDescriptionproperty 
mapDescription:String

Settings of a map of the current document which will be used for rendering a layer to image.


Implementation
    public function get mapDescription():String
    public function set mapDescription(value:String):void
zoomToLayerproperty 
zoomToLayer:Boolean

Either zoom the map to layer before rendering to image or not. If true, the map will be zoomed to layer before rendering and the whole layer will be rendered to image. Otherwise, the whole map will be drown with the layer on it. It is recommended to set this option to true value.

The default value is true.


Implementation
    public function get zoomToLayer():Boolean
    public function set zoomToLayer(value:Boolean):void
Constructor Detail
RenderingParameters()Constructor
public function RenderingParameters(imageDescription:ImageDescription = null, mapDescription:String = null)

Creates a new instance of the RenderingParameters class.

Parameters
imageDescription:ImageDescription (default = null) — Image description.
 
mapDescription:String (default = null) — Map description XML string.



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00