com.esri.bacore.thematicmapping.symbolization.TMClassificationProvider

	Property	Defined By
		classification : Classification Classification instance responsible for calculation class breaks.	TMClassificationProvider
		classificationIsLocked : Boolean [override] [read-only] Indicates that a classification provided with this instance is locked and cannot be updated right now.	TMClassificationProvider
		classificationRangeType : uint [read-only] Current type of the whole classification range (bitwise collection of flags from the RangeType class).	TMClassificationProvider
		createSymbolFactory : Function A factory method to be used for creating a symbol by color.	TMSymbolizationProvider
		formatRangesWithUnits : Boolean True value of this property means formatting of ranges with units.	TMClassificationProvider
		labelFunction : Function The function to prepare a class break label.	TMClassificationProvider
		lastClassificationResults : ClassificationResults [read-only] Last classification results.	TMClassificationProvider
		layer : TMLayer [read-only] Thematic layer associated with this component.	TMSymbolizationProvider
		outOfRangeColor : uint Color to show graphics whose thematic value is out of range.	TMClassificationProvider
		simpleRendererLabel : String This label is assigned to a simple renderer created with createSimpleRenderer method.	TMSymbolizationProvider

	Method	Defined By
		TMClassificationProvider() Initializes a new instance of the TMClassificationProvider class.	TMClassificationProvider
		createRenderer():Renderer [override] Creates a renderer for the current classification.	TMClassificationProvider
		doUnlockClassification():Boolean [override] Unlocks the classification provided with this instance without raising the ClassificationChanged event.	TMClassificationProvider
		getClassificationRanges():Array Gets classification range infos to be shown in legend.	TMClassificationProvider
		lockClassification(classificationRangeType:uint):void Locks the current classification and specifies a type of classification range for it.	TMClassificationProvider
		setLayer(layer:TMLayer):void	TMSymbolizationProvider
		unlockClassification():void Unlocks the classification provided with this instance and raises the CLASSIFICATION_CHANGED event if the classification lock state was changed from locked to unlocked.	TMSymbolizationProvider
		updateClassification(data:Array):Boolean [override] Updates classification provided with this instance by a list of thematic values.	TMClassificationProvider

	Method	Defined By
		createSimpleRenderer():Renderer Creates a simple renderer whose symbol is the mid value of the current color ramp of the associated thematic layer and label is the simpleRendererLabel property value.	TMSymbolizationProvider
		createSymbol(color:uint, index:int):Symbol Create a symbol by the given color.	TMSymbolizationProvider
		createUniqueValueRenderer():Renderer Deprecated Since Community Analyst API for Flex 2.2: Please Use createSimpleRenderer() Creates unique-value renderer whose default symbol is the mid value of the current color ramp of the associated thematic layer.	TMSymbolizationProvider
		onClassificationChanged():void Dispatches the CLASSIFICATION_CHANGED event.	TMSymbolizationProvider

	Event	Summary	Defined By
		propertyChange	The propertyChange event is dispatched when a property of the symbolization provider is changed.	TMSymbolizationProvider

	Constant	Defined By
		CLASSIFICATION_CHANGED : String = classificationChanged [static] The TMSymbolizationProvider.CLASSIFICATION_CHANGED constant defines the value of the type property of the flash.events.Event object for a classificationChanged event.	TMSymbolizationProvider

Property Detail

classification

property

classification:Classification

Classification instance responsible for calculation class breaks.

The default value is an instance of the TMClassification type.

This property can be used as the source for data binding.

Implementation
public function get classification():Classification
public function set classification(value:Classification):void

See also

RangeType

formatRangesWithUnits

property

formatRangesWithUnits:Boolean

True value of this property means formatting of ranges with units.

The default value is false.

This property can be used as the source for data binding.

Implementation
public function get formatRangesWithUnits():Boolean
public function set formatRangesWithUnits(value:Boolean):void

labelFunction

property

labelFunction:Function

Since :

Community Analyst API for Flex 2.2.

The function to prepare a class break label.

The signature of this function should be the following:

labelFunction(type:RangeType, bottomValue:ValueInfo, topValue:ValueInfo):String

If this function is null, the label is prepared using the default label function:

         
         function defaultLabelFunction(type:RangeType, bottomValue:ValueInfo, topValue:ValueInfo):String
         {
           switch (type)
           {
             case RangeType.BOUNDED: return bottomValue.toString() + " to " + topValue.toString();
             case RangeType.UNBOUNDED_BOTTOM: return "Below " + topValue.toString();
             case RangeType.UNBOUNDED_TOP: return bottomValue.toString() +  " and above";
             default: return "unbounded";
           }
         }

Implementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void

lastClassificationResults

property

lastClassificationResults:ClassificationResults [read-only]

Last classification results.

The default value is an empty collection of classification results.

Implementation
public function get lastClassificationResults():ClassificationResults

outOfRangeColor

property

outOfRangeColor:uint

Color to show graphics whose thematic value is out of range.

The default value is 0.

This property can be used as the source for data binding.

Implementation
public function get outOfRangeColor():uint
public function set outOfRangeColor(value:uint):void

Constructor Detail

TMClassificationProvider

()

Constructor

public function TMClassificationProvider()

Initializes a new instance of the TMClassificationProvider class.

Method Detail

createRenderer

()

method

override public function createRenderer():Renderer

Creates a renderer for the current classification.

Returns

Renderer — A new renderer.

doUnlockClassification

()

method

override public function doUnlockClassification():Boolean

Unlocks the classification provided with this instance without raising the ClassificationChanged event.

Returns

Boolean — True if classification lock state was changed from locked to unlocked.

getClassificationRanges

()

method

public function getClassificationRanges():Array

Gets classification range infos to be shown in legend. If classification results are empty, an empty array is returned.

Returns

Array — Array of RangeInfo items.

Esri Community Analyst API for Flex 2.2 Reference	All Packages \| All Classes \| Index \| Frames No Frames
TMClassificationProvider	Properties \| Methods \| Events \| Constants

Package	com.esri.bacore.thematicmapping.symbolization
Class	public class TMClassificationProvider
Inheritance	TMClassificationProvider TMSymbolizationProvider flash.events.EventDispatcher