Packagecom.esri.ags.clusterers.supportClasses
Classpublic class SimpleClusterSymbol
InheritanceSimpleClusterSymbol Inheritance Symbol Inheritance flash.events.EventDispatcher

Since : ArcGIS API for Flex 2.0

Simple cluster symbol that draws a rounded square with cluster count in the center. This the default symbol of the ESRI Clusters if none is defined.


Public Properties
 PropertyDefined By
  alpha : Number
The alpha transparency of the cluster symbol.
SimpleClusterSymbol
  alphas : Array
The alphas associated with weights.
SimpleClusterSymbol
  color : uint
The color of the cluster symbol.
SimpleClusterSymbol
  colors : Array
The colors associated with weights.
SimpleClusterSymbol
  fractionDigits : uint
An integer between 0 and 20, inclusive, that represents the desired number of decimal places when displaying the cluster weight.
SimpleClusterSymbol
  size : Number
The cell size (width) in pixels.
SimpleClusterSymbol
  sizes : Array
The sizes associated with weights.
SimpleClusterSymbol
  textFormat : TextFormat
The text format.
SimpleClusterSymbol
  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.
SimpleClusterSymbol
Public Methods
 MethodDefined By
  
SimpleClusterSymbol()
Creates a new SimpleClusterSymbol instance.
SimpleClusterSymbol
 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
alphaproperty
alpha:Number

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

The default value is 0.75 (semi-transparent).

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


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
alphasproperty 
alphas:Array

The alphas associated with weights.

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


Implementation
    public function get alphas():Array
    public function set alphas(value:Array):void
colorproperty 
color:uint

The color of the cluster symbol.

The default value is 0x76D100 (turtle green).

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


Implementation
    public function get color():uint
    public function set color(value:uint):void
colorsproperty 
colors:Array

The colors associated with weights.

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


Implementation
    public function get colors():Array
    public function set colors(value:Array):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
sizeproperty 
size:Number

The cell size (width) in pixels.

The default value is 70 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.

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
SimpleClusterSymbol()Constructor
public function SimpleClusterSymbol()

Creates a new SimpleClusterSymbol instance.




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

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