Packagecom.esri.baserver.tasks.rendering
Classpublic class RenderAnalysesParameters
InheritanceRenderAnalysesParameters Inheritance BABaseParameters Inheritance Object
Implements IBAResultProcessor

The RenderAnalysesParameters class provides input parameters for the Render Analyses task.

View the examples

See also

RenderAnalysesTask
GetDefaultMapDescriptionTask


Public Properties
 PropertyDefined By
  analysesDescription : Array
Array of layer items in the repository that will be rendered as an image.
RenderAnalysesParameters
  renderingParameters : RenderingParameters
Configuration options for rendering the output to a map image.
RenderAnalysesParameters
 InheritedresultType : BAResultType
[read-only] Type of a result returned by the task associated with these parameters.
BABaseParameters
 InheritedtaskName : String
[read-only] Name of a Business Analyst Server task associated with these parameters.
BABaseParameters
Public Methods
 MethodDefined By
  
RenderAnalysesParameters(analysesDescription:Array = null)
Creates a new instance of the RenderAnalysesParameters class.
RenderAnalysesParameters
Property Detail
analysesDescriptionproperty
analysesDescription:Array

Array of layer items in the repository that will be rendered as an image. This array should contain instances of the LayerItem type.


Implementation
    public function get analysesDescription():Array
    public function set analysesDescription(value:Array):void
renderingParametersproperty 
renderingParameters:RenderingParameters

Configuration options for rendering the output to a map image. The zoomToLayer option is currently not supported.

The default value is an instance with empty content.


Implementation
    public function get renderingParameters():RenderingParameters
    public function set renderingParameters(value:RenderingParameters):void
Constructor Detail
RenderAnalysesParameters()Constructor
public function RenderAnalysesParameters(analysesDescription:Array = null)

Creates a new instance of the RenderAnalysesParameters class.

Parameters
analysesDescription:Array (default = null) — Array of layer items in the repository that will be rendered as an image.
Examples
ActionScript to create RenderAnalysesParameters and then use in a Render Analyses task:
                     
     var parameters : RenderAnalysesParameters = new RenderAnalysesParameters();
     
     // analysesDescription is an array of LayerItem 
     //var analysesDescription:Array = [new LayerItem(item, transparency, layerName)];
     
     parameters.analysesDescription = analysesDescription;
     
     // Set image configuration options for rendering output.
     parameters.renderingParameters.imageDescription = new ImageDescription(imageDisplay, imageType);
     
     renderAnalysesTask.execute(parameters, new Responder(resultHandler, faultHandler));