| Package | com.esri.bacore.thematicmapping.extensionClasses |
| Class | public class Highlighter |
| Inheritance | Highlighter  TMLayerComponent flash.events.EventDispatcher |
| Subclasses | TMHighlighter, TMHighlightFilter |
The updateHighlightItems method is abstract. It should be implemented in derived classes.
| Property | Defined By | ||
|---|---|---|---|
| highlightSymbol : Symbol
Symbol to highlight graphic items with. | Highlighter | ||
 | layer : TMLayer
Thematic layer associated with this extension object. | TMLayerComponent | |
| priority : int
Highlighting operation priority. | Highlighter | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the Highlighter class. | Highlighter | ||
updateHighlighting():void
Updates highlighting of features of the thematic layer associated with this instance. | Highlighter | ||
| Method | Defined By | ||
|---|---|---|---|
makeHighlightSymbol(currentSymbol:Symbol):Symbol
Makes a highlight symbol from a current symbol and the
highlightSymbol property value. | Highlighter | ||
|
Updates the state of object when associated thematic layer is changed. | TMLayerComponent | |
[static]
Updates symbols for given items. | Highlighter | ||
updateHighlightItems(layer:TMLayer):void
Updates items to be highlighted. | Highlighter | ||
| highlightSymbol | property |
Hide Inherited Public Properties
Show Inherited Public PropertieshighlightSymbol:SymbolSymbol to highlight graphic items with.
Specifying this property as SimpleFillSymbol, you have a possibility to highlight separately
an interior or border of graphic or both interior and border. If the style property is
specified and not equal to SimpleFillSymbol.STYLE_NULL,
the interior will be highlighted with the given style, color, and alpha
values of the highlightSymbol.
If not, the interior remains unchanged.
If the outline property is specified, the border will be highlighted with the given
outline symbol. If not, the border remains unchanged.
This behavior is implemented with the makeHighlightSymbol method and can be overriden in derived classes.
The default value is Simple fill symbol with red fill brush.
This property can be used as the source for data binding.
public function get highlightSymbol():Symbol public function set highlightSymbol(value:Symbol):void| priority | property |
priority:intHighlighting operation priority.
To highlight features of a thematic layer, the priority should be zero or more. Negative value means that highlighting works in invisible mode—highilight items can be updated but highlighting doesn't applied.
If more than one handler of tmRenderer event is associated with the same thematic layer, updates with higher priority override updates with lesser priority. If two or more updates are applied with the same priority, the latest update is taken into account.
The default value is 0.
This property can be used as the source for data binding.
public function get priority():int public function set priority(value:int):void| Highlighter | () | Constructor |
public function Highlighter()Creates a new instance of the Highlighter class.
| makeHighlightSymbol | () | method |
protected function makeHighlightSymbol(currentSymbol:Symbol):SymbolMakes a highlight symbol from a current symbol and the highlightSymbol property value.
The base method at first tests that both the currentSymbol and
highlightSymbol
are of SimpleFillSymbol type. If not, the highlightSymbol is returned.
If both symbols are of SimpleFillSymbol type, the output highlight symbol receives
interior and outline properties from the highlightSymbol if they are specified in it or from
currentSymbol if not.
Parameters
currentSymbol:Symbol — Current symbol already generated by renderer.
|
Symbol |
| update | () | method |
protected static function update(items:Object, layer:TMLayer):voidUpdates symbols for given items.
Parameters
items:Object — Items to be updated (this is an Array or ArrayCollection object).
| |
layer:TMLayer — Layer whose items will be updated.
|
| updateHighlighting | () | method |
public function updateHighlighting():voidUpdates highlighting of features of the thematic layer associated with this instance.
Updates are applied automatically when properties of highlighter are changed or layer is re-rendered. So, you need not call this method manually in ordinary cases.
| updateHighlightItems | () | method |
protected function updateHighlightItems(layer:TMLayer):voidUpdates items to be highlighted.
Parameters
layer:TMLayer — Thematic layer whose highlight items should be updated.
|