Packagecom.esri.bao.tasks.thematicmapping
Classpublic final class ThematicMappingRendererInfo
InheritanceThematicMappingRendererInfo Inheritance flash.events.EventDispatcher

The ThematicMappingRendererInfo class stores thematic mapping render parameters.



Public Properties
 PropertyDefined by
  availableSummarizations : Array
[read-only] Array of available summarization variables consisting of SummarizationInfo items.
ThematicMappingRendererInfo
  classificationType : ClassificationType
Classification type.
ThematicMappingRendererInfo
  colorRamp : ColorRamp
Color ramp to colorize features by.
ThematicMappingRendererInfo
  geographyLevelName : String
Name of geography level to render thamatic layer by.
ThematicMappingRendererInfo
  mappingField : String
Name of field to render thematic layer by.
ThematicMappingRendererInfo
  numBreaks : int
Number of class breaks to be rendered (a value in the range from 2 to 10).
ThematicMappingRendererInfo
  selectedSummarization : SummarizationInfo
[read-only] Selected summarization variable.
ThematicMappingRendererInfo
  tmValueType : TMValueType
Type of summarization to apply thematic mapping by.
ThematicMappingRendererInfo
  where : String
Query WHERE clause.
ThematicMappingRendererInfo
Public Methods
 MethodDefined by
  
Creates a new instance of the ThematicMappingRendererInfo class.
ThematicMappingRendererInfo
  
isEnabledTMValueType(summarization:SummarizationInfo, value:TMValueType):Boolean
Tests a summarization variable to support the given type of summarization.
ThematicMappingRendererInfo
Events
 EventSummaryDefined by
   The propertyChange event is dispatched when one of rendering properties is changed.ThematicMappingRendererInfo
Property detail
availableSummarizationsproperty
availableSummarizations:Array  [read-only]

Array of available summarization variables consisting of SummarizationInfo items.

Implementation
    public function get availableSummarizations():Array

See also

classificationTypeproperty 
classificationType:ClassificationType  [read-write]

Classification type.

The default value is ClassificationType.QUANTILE.

Implementation
    public function get classificationType():ClassificationType
    public function set classificationType(value:ClassificationType):void
colorRampproperty 
colorRamp:ColorRamp  [read-write]

Color ramp to colorize features by.

Implementation
    public function get colorRamp():ColorRamp
    public function set colorRamp(value:ColorRamp):void
geographyLevelNameproperty 
geographyLevelName:String  [read-write]

Name of geography level to render thamatic layer by.

Implementation
    public function get geographyLevelName():String
    public function set geographyLevelName(value:String):void
mappingFieldproperty 
mappingField:String  [read-write]

Name of field to render thematic layer by.

Implementation
    public function get mappingField():String
    public function set mappingField(value:String):void
numBreaksproperty 
numBreaks:int  [read-write]

Number of class breaks to be rendered (a value in the range from 2 to 10).

The default value is 5.

Implementation
    public function get numBreaks():int
    public function set numBreaks(value:int):void
selectedSummarizationproperty 
selectedSummarization:SummarizationInfo  [read-only]

Selected summarization variable.

Implementation
    public function get selectedSummarization():SummarizationInfo
tmValueTypeproperty 
tmValueType:TMValueType  [read-write]

Type of summarization to apply thematic mapping by.

Not all summarization types are allowed for every summarization variable. If currently selected summarization variable doesn't support a summarization type to be set, the TMValueType.NUMBER is set. Use the isEnabledTMValueType(tmValue) function to test the currently selected summarization variable to support a summarization type.

Implementation
    public function get tmValueType():TMValueType
    public function set tmValueType(value:TMValueType):void
whereproperty 
where:String  [read-write]

Query WHERE clause.

Implementation
    public function get where():String
    public function set where(value:String):void
Constructor detail
ThematicMappingRendererInfo()constructor
public function ThematicMappingRendererInfo()

Creates a new instance of the ThematicMappingRendererInfo class.

Method detail
isEnabledTMValueType()method
public function isEnabledTMValueType(summarization:SummarizationInfo, value:TMValueType):Boolean

Tests a summarization variable to support the given type of summarization.

Parameters
summarization:SummarizationInfo — Summarization variable to test.
 
value:TMValueType — Type of summarization to test.

Returns
Boolean — True if the given summarization type is supported.
Event detail
propertyChangeevent 
Event object type: mx.events.PropertyChangeEvent

The propertyChange event is dispatched when one of rendering properties is changed.