Packagecom.esri.bacore.thematicmapping.extensionClasses
Classpublic class TMTooltipProvider
InheritanceTMTooltipProvider Inheritance TMLayerComponent Inheritance flash.events.EventDispatcher

The TMTooltipProvider class provides updating of the thematic layer graphics tooltips.



Public Properties
 PropertyDefined By
 Inheritedlayer : TMLayer
Thematic layer associated with this extension object.
TMLayerComponent
  tooltipStyle : ValueDescriptionStyle
Tooltip visualization style.
TMTooltipProvider
Public Methods
 MethodDefined By
  
Creates a new instance of the TMTooltipProvider class.
TMTooltipProvider
Protected Methods
 MethodDefined By
  
composeTooltip(descriptionFields:Array):String
Composes a tooltip by values of feature description fields.
TMTooltipProvider
  
Updates the tooltip for the given graphic.
TMTooltipProvider
Events
 Event Summary Defined By
 InheritedThe propertyChange event is dispatched when a property of thematic layer component is changed.TMLayerComponent
Property Detail
tooltipStyleproperty
tooltipStyle:ValueDescriptionStyle

Tooltip visualization style.

The default value is ValueDescriptionStyle.SIMPLE.

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


Implementation
    public function get tooltipStyle():ValueDescriptionStyle
    public function set tooltipStyle(value:ValueDescriptionStyle):void
Constructor Detail
TMTooltipProvider()Constructor
public function TMTooltipProvider()

Creates a new instance of the TMTooltipProvider class.

Method Detail
composeTooltip()method
protected function composeTooltip(descriptionFields:Array):String

Composes a tooltip by values of feature description fields.

The default implementation composes a simple multiline tooltip with keys delimitted from values with semicolon (:) symbol. In the case of a single description field, the field key is ignored.

Parameters

descriptionFields:Array — Feature description fields.

Returns
String — A new tooltip string (null value means no tooltip)
updateTooltip()method 
protected function updateTooltip(e:TMValueEvent):void

Updates the tooltip for the given graphic.

Parameters

e:TMValueEvent — Thematic value updating event.