Packagecom.esri.ags.clusterers.supportClasses
Classpublic class FlareSymbol
InheritanceFlareSymbol Inheritance Symbol Inheritance flash.events.EventDispatcher

Since : ArcGIS API for Flex 2.0

Symbol to render a cluster as a flare. Initially, the cluster is represented as circle with a count of the number of clustered graphics. When the user hovers over circle, it flares to show the individual clustered elements.

Visual overview of FlareSymbol properties

See also

com.esri.ags.events.FlareMouseEvent
com.esri.ags.clusterers.WeightedClusterer
Live sample - Clustering

Public Properties
 PropertyDefined By
  backgroundAlpha : Number
The background alpha of the FlareSymbol.
FlareSymbol
  backgroundAlphas : Array
The background alphas associated with weights.
FlareSymbol
  backgroundColor : uint
The background color of the FlareSymbol.
FlareSymbol
  backgroundColors : Array
The background colors associated with weights.
FlareSymbol
  borderAlpha : Number
The border alpha.
FlareSymbol
  borderColor : uint
The border color of the FlareSymbol.
FlareSymbol
  borderThickness : Number
The border thickness of the FlareSymbol, in pixels.
FlareSymbol
  flareMaxCount : int
The max number of cluster elements to flare.
FlareSymbol
  flareSize : Number
The flare element radius.
FlareSymbol
  flareSizeIncOnRollOver : Number
The flare element radius increment when the user rolls over it.
FlareSymbol
  fractionDigits : uint
An integer between 0 and 20, inclusive, that represents the desired number of decimal places when displaying the cluster weight.
FlareSymbol
  maxCountPerRing : int
Max count of flare elements per ring.
FlareSymbol
  ringAngleInc : Number
Additional flare ring angle increment value.
FlareSymbol
  ringAngleStart : Number
Flare ring initial angle value.
FlareSymbol
  ringDistanceInc : Number
Additional flare ring incremental distance value.
FlareSymbol
  size : Number
The diameter size of the center circle, in pixels.
FlareSymbol
  sizes : Array
The sizes associated with weights.
FlareSymbol
  textFormat : TextFormat
The text format.
FlareSymbol
  weights : Array
The weights to use as breaks when selecting a color from colors, an alpha from alphas and a size from sizes for a cluster weight.
FlareSymbol
Public Methods
 MethodDefined By
  
FlareSymbol()
Creates a new FlareSymbol instance.
FlareSymbol
 Inherited
clear(sprite:Sprite):void
Clears the graphics that were drawn to the sprite object.
Symbol
 Inherited
createSwatch(width:Number = 50, height:Number = 50):UIComponent
Creates a swatch for a symbol which can be used in a legend.
Symbol
 Inherited
destroy(sprite:Sprite):void
Removes all the graphics that were drawn to the sprite object and resets its properties.
Symbol
 Inherited
draw(sprite:Sprite, geometry:Geometry, attributes:Object, map:Map):void
Draw the graphics on the sprite object.
Symbol
 Inherited
initialize(sprite:Sprite, geometry:Geometry, attributes:Object, map:Map):void
Initialize the sprite.
Symbol
Protected Methods
 MethodDefined By
 Inherited
dispatchEventChange():void
Helper function to dispatch a change event.
Symbol
 Inherited
removeAllChildren(sprite:Sprite):void
Removes all children from the sprite object.
Symbol
 Inherited
toScreenX(map:Map, mapX:Number):Number
Converts the x-coordinate of map point to a screen point.
Symbol
 Inherited
toScreenY(map:Map, mapY:Number):Number
Converts the y-coordinate of map point to a screen point.
Symbol
Property Detail
backgroundAlphaproperty
backgroundAlpha:Number

The background alpha of the FlareSymbol. Possible values range from 0.0 (invisible, fully transparent) to 1.0 (opaque, fully visible).

The default value is 1.0 (opaque, fully visible).

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


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundAlphasproperty 
backgroundAlphas:Array

The background alphas associated with weights.

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


Implementation
    public function get backgroundAlphas():Array
    public function set backgroundAlphas(value:Array):void
backgroundColorproperty 
backgroundColor:uint

The background color of the FlareSymbol.

The default value is 0x76D100 (turtle green).

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


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
backgroundColorsproperty 
backgroundColors:Array

The background colors associated with weights.

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


Implementation
    public function get backgroundColors():Array
    public function set backgroundColors(value:Array):void
borderAlphaproperty 
borderAlpha:Number

The border alpha. Possible values range from 0.0 (invisible, fully transparent) to 1.0 (opaque, fully visible).

The default value is 1.0 (opaque, fully visible).

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


Implementation
    public function get borderAlpha():Number
    public function set borderAlpha(value:Number):void
borderColorproperty 
borderColor:uint

The border color of the FlareSymbol.

The default value is 0x000000 (black).

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


Implementation
    public function get borderColor():uint
    public function set borderColor(value:uint):void
borderThicknessproperty 
borderThickness:Number

The border thickness of the FlareSymbol, in pixels.

The default value is 2 pixels.

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


Implementation
    public function get borderThickness():Number
    public function set borderThickness(value:Number):void
flareMaxCountproperty 
flareMaxCount:int

The max number of cluster elements to flare. If the mouse rolls over a cluster that has a set of graphics less than or equal to this count, then it will flare.

The default value is 30 graphics.

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


Implementation
    public function get flareMaxCount():int
    public function set flareMaxCount(value:int):void
flareSizeproperty 
flareSize:Number

The flare element radius.

The default value is 5 pixels.

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


Implementation
    public function get flareSize():Number
    public function set flareSize(value:Number):void
flareSizeIncOnRollOverproperty 
flareSizeIncOnRollOver:Number

The flare element radius increment when the user rolls over it.

The default value is 2 pixels.

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


Implementation
    public function get flareSizeIncOnRollOver():Number
    public function set flareSizeIncOnRollOver(value:Number):void
fractionDigitsproperty 
fractionDigits:uint

An integer between 0 and 20, inclusive, that represents the desired number of decimal places when displaying the cluster weight.

The default value is 0.

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


Implementation
    public function get fractionDigits():uint
    public function set fractionDigits(value:uint):void
maxCountPerRingproperty 
maxCountPerRing:int

Max count of flare elements per ring.

The default value is 6 elements.

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


Implementation
    public function get maxCountPerRing():int
    public function set maxCountPerRing(value:int):void
ringAngleIncproperty 
ringAngleInc:Number

Additional flare ring angle increment value.

The default value is 15.

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


Implementation
    public function get ringAngleInc():Number
    public function set ringAngleInc(value:Number):void
ringAngleStartproperty 
ringAngleStart:Number

Flare ring initial angle value.

The default value is 5.

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


Implementation
    public function get ringAngleStart():Number
    public function set ringAngleStart(value:Number):void
ringDistanceIncproperty 
ringDistanceInc:Number

Additional flare ring incremental distance value.

The default value is 20 pixels.

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


Implementation
    public function get ringDistanceInc():Number
    public function set ringDistanceInc(value:Number):void
sizeproperty 
size:Number

The diameter size of the center circle, in pixels.

The default value is 30 pixels.

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


Implementation
    public function get size():Number
    public function set size(value:Number):void
sizesproperty 
sizes:Array

The sizes associated with weights. Make sure to set a fallback size value that is greater or equal to the max value in the array.

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


Implementation
    public function get sizes():Array
    public function set sizes(value:Array):void
textFormatproperty 
textFormat:TextFormat

The text format.

The default value is null.

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


Implementation
    public function get textFormat():TextFormat
    public function set textFormat(value:TextFormat):void
weightsproperty 
weights:Array

The weights to use as breaks when selecting a color from colors, an alpha from alphas and a size from sizes for a cluster weight. If the cluster weight is not in the range, then the color, alpha and size will be used as fall back values.

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


Implementation
    public function get weights():Array
    public function set weights(value:Array):void
Constructor Detail
FlareSymbol()Constructor
public function FlareSymbol()

Creates a new FlareSymbol instance.




© 2008-2011 Esri, Inc. All rights reserved.

Wed Nov 30 2011, 04:19 PM -08:00