| Package | com.esri.bacore.thematicmapping |
| Class | public class TMSymbolizationProvider |
| Inheritance | TMSymbolizationProvider  flash.events.EventDispatcher |
| Subclasses | TMClassificationProvider |
| Property | Defined By | ||
|---|---|---|---|
| classificationIsLocked : Boolean [read-only]
Indicates that a classification provided with this instance is locked and cannot be updated right now. | TMSymbolizationProvider | ||
| createSymbolFactory : Function
A factory method to be used for creating a symbol by color. | TMSymbolizationProvider | ||
| layer : TMLayer [read-only]
Thematic layer associated with this component. | TMSymbolizationProvider | ||
| simpleRendererLabel : String
This label is assigned to a simple renderer created with createSimpleRenderer method. | TMSymbolizationProvider | ||
| Method | Defined By | ||
|---|---|---|---|
Initializes a new instance of the TMSymbolizationProvider class. | TMSymbolizationProvider | ||
createRenderer():Renderer
Creates a renderer for the current classification. | TMSymbolizationProvider | ||
doUnlockClassification():Boolean
Unlocks the classification provided with this instance without raising events. | TMSymbolizationProvider | ||
| 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
Updates classification provided with this instance by an array of thematic values. | TMSymbolizationProvider | ||
| 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 | ||
onLayerChanged():void
This method is invoked when thematic layer is changed. | TMSymbolizationProvider | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| 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 | ||
| classificationIsLocked | property |
classificationIsLocked:Boolean [read-only] Indicates that a classification provided with this instance is locked and cannot be updated right now.
The base symbolization provider has a simple classification consisting of one class and this property value is always true for it. This property should be overriden in derived classes to provide a thematic classification of features.
public function get classificationIsLocked():Boolean| createSymbolFactory | property |
createSymbolFactory:FunctionA factory method to be used for creating a symbol by color.
The signature of this method is the following:
createSymbolFactory(layer:TMLayer, color:uint, index:int):Symbol;
The index parameter passed to this factory specifies a zero-based index of color
in the color ramp. Two special values of indices are also possible: -1 means
that a symbol for the mid color of the color ramp is requested
(this case is used with the UniqueValueRenderer when classification ranges are missing)
and -2 means that out-of-range symbol is requested.
public function get createSymbolFactory():Function public function set createSymbolFactory(value:Function):void| layer | property |
layer:TMLayer [read-only] Thematic layer associated with this component.
public function get layer():TMLayer| simpleRendererLabel | property |
simpleRendererLabel:String| Since : | Community Analyst API for Flex 2.2. |
This label is assigned to a simple renderer created with createSimpleRenderer method.
public function get simpleRendererLabel():String public function set simpleRendererLabel(value:String):void| TMSymbolizationProvider | () | Constructor |
public function TMSymbolizationProvider()Initializes a new instance of the TMSymbolizationProvider class.
| createRenderer | () | method |
public function createRenderer():RendererCreates a renderer for the current classification.
A thematic layer should be associated with this instance to allow using this method. The base implementation returns a unique-value renderer.
ReturnsRenderer — A new renderer.
|
| createSimpleRenderer | () | method |
protected function createSimpleRenderer():Renderer| Since : | Community Analyst API for Flex 2.2. |
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.
ReturnsRenderer — A new renderer.
|
| createSymbol | () | method |
protected function createSymbol(color:uint, index:int):SymbolCreate a symbol by the given color.
This factory-method creates symbols which will be used in a renderer of thematic layer.
See createSymbolFactory property for details.
If the createSymbolFactory property is null, a simple fill symbol with
solid fill color is created and border is got from the layer's borderSymbol property.
Parameters
color:uint — RGB color to create symbol for.
| |
index:int — Index of color in the color ramp.
|
Symbol — A new symbol.
|
| createUniqueValueRenderer | () | method |
protected function createUniqueValueRenderer():RendererCreates unique-value renderer whose default symbol is the mid value of the current color ramp of the associated thematic layer.
ReturnsRenderer — A new renderer.
|
| doUnlockClassification | () | method |
public function doUnlockClassification():BooleanUnlocks the classification provided with this instance without raising events.
The base version of this method does nothing and returns the false value.
ReturnsBoolean — True if the classification lock state was changed from locked to unlocked.
|
| onClassificationChanged | () | method |
protected function onClassificationChanged():void
Dispatches the CLASSIFICATION_CHANGED event.
| onLayerChanged | () | method |
protected function onLayerChanged():voidThis method is invoked when thematic layer is changed.
The base version of this method does nothing.
| setLayer | () | method |
| unlockClassification | () | method |
public function 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.
| updateClassification | () | method |
public function updateClassification(data:Array):BooleanUpdates classification provided with this instance by an array of thematic values.
The data array should contain numerical values.
Null value of data parameter means that the thematic value for features doesn't calculated.
The base implementation of this method returns false.
Parameters
data:Array — Input data.
|
Boolean — True if the classification was updated.
|
| propertyChange | Event |
mx.events.PropertyChangeEventmx.events.PropertyChangeEvent.PROPERTY_CHANGE
The propertyChange event is dispatched when a property of the symbolization provider is changed.
| CLASSIFICATION_CHANGED | Constant |
public static const CLASSIFICATION_CHANGED:String = classificationChanged
The TMSymbolizationProvider.CLASSIFICATION_CHANGED constant defines the value of the
type property of the flash.events.Event object for a classificationChanged event.