Packagefr.kapit.pictogram
Classpublic class PictogramChart
InheritancePictogramChart Inheritance KapSkinnableContainer Inheritance spark.components.SkinnableContainer

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Pictogram is a spark component dedicated to data statistics vulgarization, comparison. It aims at making statistical information reliably understandable through simple visual comparison and symbolization patterns.

The component is a king of pictorial chart that converts each data entry containing a description, statstic value and optionally a symbol into a cell where the statistical value is converted into a set of full and empty boxes and the descriptive information is displayed within it. Cells and units in the cell grid are layouted using Spark Layouts.

The default skin of the component contains a Group surrounded with scroller in case the layout constraints leads to make elements out of the visual bounds. Cells have a default size and the applied spark layout should be able make cells fit the screen by modifiying their size dimensions. The cellWidth and cellHeight properties are provided in cas the applied Spark Layout don't support elements size autofit. The TileLayout and its columnAlign and rowAlign style properties is suited for layouting the cells.

A default TileLayout is applied and some style properties controls this layout processing.

To use this component, a dataProvider containing data entries must be provided in addition to assigning a valueField for extracting values from the data entries and computing percentages.

	 <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
	 			   xmlns:s="library://ns.adobe.com/flex/spark"
	 			   xmlns:mx="library://ns.adobe.com/flex/mx"
	 			   xmlns:pictogramChart="fr.kapit.pictogramChart.
	 			   width="100%" height="100%">
	 	<fx:Declarations>
	 		<fx:XML id="dp" xmlns="">
	 			<Countries>
	 			<Country code="FR" name="France" value="55"/>
	 			<Country code="USA" name="Germany" value="36"/>
	 			<Country code="TN" name="Italia" value="21"/>
	 			<Country code="EGY" name="England" value="31"/>
	 			</Countries>
	 		</fx:XML>
	 	</fx:Declarations>
	 
	 	<s:Group width="100%" height="100%">
	 		<pictogramChart:Pictogram dataProvider="{dp}"
	 						   valueField="@value"
	 						   metaDataField="@name"  width="100%" height="100%">
	 		</pictogramChart:Pictogram>
	 	</s:Group>
	 
	 </s:Application>
	  

Default MXML PropertymxmlContentFactory

See also

fr.kapit.pictogram.skins.PictogramSkin
fr.kapit.pictogram.base.PictogramCell


Public Properties
 PropertyDefined By
  actionsPackager : IActionPackage
A packager used by Pictogram to activate new actions instead for the actual ones.
PictogramChart
 InheritedanalysisPath : Object
An array used for CSV and General ICollectionView files and enables data source analysis with a given logic.
KapSkinnableContainer
 InheritedattributesDescriptor : AttributesDescriptor
It assigns to each column reference in the analysisPath its attributes.
KapSkinnableContainer
  cells : Array
List of PictogramCell instances added to the Pictogram contentGroup.
PictogramChart
 InheritedcsvDelimiter : String
CSV delimiter used for csv source parsing.
KapSkinnableContainer
 InheritedcustomTreeDataDescriptor : ITreeDataDescriptor
Custom Tree Data descriptor for navigating inside data provider object.
KapSkinnableContainer
 InheriteddataProvider : Object
Visualizer Data provider.
KapSkinnableContainer
  enableRoundedPercentages : Boolean
Flag indicating, if set to true, that percentages should be rounded to 0 or 1 and cell grid units should be filled accordingly.
PictogramChart
  filterAlpha : Number
The alpha of faded cells which value is not on values range defined by valueFilters.
PictogramChart
 InheritedgroupProperty : String
Property in a node data object (XML node for example) which value refers to the group dependency.The value is considered as the unique id of the group.
KapSkinnableContainer
 InheritedidProperty : String
For any data item in any ICollectionView dataProvider (XML, array collection containing objects with children property), The idProperty is the property which value is considered as the unique id of the item (node, group or link).
KapSkinnableContainer
 InheritedignoreRoot : Boolean
Indicator if common root node of ICollectionView should be ignored.
KapSkinnableContainer
 InheritedkData : KData
[read-only] private
KapSkinnableContainer
 InheritedlinkProperty : String
Property in a node data object depending to an ICollectionView dataProvider which value will be assigned to the created link.
KapSkinnableContainer
 InheritedmergeDescriptor : MergeDescriptor
Descriptor defining merging tasks that must be applied on a CSV source before displaying it.
KapSkinnableContainer
  metaDataField : String
Cell data property which value is assigned to the metaDataLabel skin part of any PictogramCell (if the skin part exists).
PictogramChart
  percentageFunction : Function
Function returning the percentage value from a data entry or cell data.
PictogramChart
 InheritedrecordDelimiter : String
Record delimiter of CSV fields.
KapSkinnableContainer
 InheritedreportingFunctions : Dictionary
Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment.
KapSkinnableContainer
  symbolField : String
Cell data property which value is assimilated as the source property of the symbolArea skin part of any PictogramCell (if the skin part exists).
PictogramChart
 InheritedtypesDescriptor : Dictionary
Column types descriptor.
KapSkinnableContainer
  unitColumnCount : uint
Actual column count of the TileLayout used with the unitsGrid skin part in any cell.
PictogramChart
  unitFillPolicy : String
Fill policy of the cell grid units according to percentage value.
PictogramChart
  unitItemRenderer : Class
Cell grid unit renderer class.
PictogramChart
  unitItemRendererFunction : Function
Cell grid unit renderer function.
PictogramChart
  unitRowCount : uint
Actual row count of the TileLayout used with the unitsGrid skin part in any cell.
PictogramChart
  valueField : String
Cell data property which value is assigned to the valueLabel skin part of any PictogramCell (if the skin part exists).
PictogramChart
  valueFilters : Array
A Array containing the min and max of cell values.
PictogramChart
  valueLabelFunction : Function
Function returning a String value from cell data.
PictogramChart
 InheritedwithHeaders : Boolean
Indicator if the CSV data provider first row are headers or not.
KapSkinnableContainer
Protected Properties
 PropertyDefined By
 Inherited_analysisPath : Array
private
KapSkinnableContainer
 Inherited_attributesDescriptor : AttributesDescriptor
private
KapSkinnableContainer
 Inherited_csvDelimiter : String = ;
private
KapSkinnableContainer
 Inherited_customTreeDataDescriptor : ITreeDataDescriptor
private
KapSkinnableContainer
  _dataChanged : Boolean = true
Flag indicating that Pictogram data has changed.
PictogramChart
 Inherited_dataProvider : Object
private
KapSkinnableContainer
 Inherited_dataProviderChanged : Boolean
private
KapSkinnableContainer
 Inherited_dataProviderType : int
private
KapSkinnableContainer
  _enableRoundedPercentages : Boolean = false
Flag indicating that percentages rounding policy has changed.
PictogramChart
 Inherited_groupProperty : String
private
KapSkinnableContainer
 Inherited_idProperty : String
private
KapSkinnableContainer
 Inherited_ignoreRoot : Boolean
private
KapSkinnableContainer
 Inherited_kData : KData
KapSkinnableContainer
 Inherited_linkProperty : String
private
KapSkinnableContainer
 Inherited_mergeDescriptor : MergeDescriptor
private
KapSkinnableContainer
 Inherited_recordDelimiter : String
private
KapSkinnableContainer
 Inherited_reportingFunctions : Dictionary
private
KapSkinnableContainer
 Inherited_reportingFunctionsChanged : Boolean
private
KapSkinnableContainer
 Inherited_typesDescriptor : Dictionary
private
KapSkinnableContainer
  _unitRendererChanged : Boolean = true
Flag indicating that unit renderers has changed.
PictogramChart
 Inherited_useMultiLink : Boolean = true
private
KapSkinnableContainer
 Inherited_withHeaders : Boolean = true
private
KapSkinnableContainer
Public Methods
 MethodDefined By
  
Constructor.
PictogramChart
  
activateAction(actionID:String, data:Object = null):void
Activates an already registered action by calling the activate method on the concerned action instance.
PictogramChart
 Inherited
addElement(element:IVisualElement):IVisualElement
[override]
KapSkinnableContainer
 Inherited
addElementAt(element:IVisualElement, index:int):IVisualElement
[override]
KapSkinnableContainer
  
deactivateAction(actionID:String):void
Deactivates an already registered and activated action by calling the deactivate method on the concerned action instance.
PictogramChart
  
Deactivates all actions in Pictogram.
PictogramChart
  
getActionData(actionID:String):Object
Returns action parameters as a typed object.
PictogramChart
  
getActionInstance(actionID:String):IAction
Returns action instance.
PictogramChart
  
getActionStatus(actionID:String):String
Returns action status given its id.
PictogramChart
  
getStyle(styleProp:String):*
[override]
PictogramChart
  
hasAction(actionID:String):Boolean
Checks if an action ID is already registered.
PictogramChart
  
hibernateAction(actionID:String):void
Performs partial action deactivation for sooner re-activation.
PictogramChart
  
messageAction(actionID:String, message:Object):void
Routes a message object to a given action instance given its ID.
PictogramChart
  
messageAllActions(message:Object):void
Routes a Pictogram message to all activated actions.
PictogramChart
  
panContent(displacementX:Number, displacementY:Number):void
Pans the content of the Pictogram if its content is greater that the Pictogram visual viewport.
PictogramChart
  
registerAction(actionClass:Class, isActivated:Boolean = false, data:Object = null):void
Registers a new action class modelizing a user interaction scenario.
PictogramChart
  
registerActionPackage(newActionPackager:IActionPackage, reset:Boolean = false):void
Register a set of actions packaged in action sets (a set of ActionSet instances).
PictogramChart
  
Register a given action set in the Pictogram based on its properties.
PictogramChart
 Inherited
setElementIndex(element:IVisualElement, index:int):void
[override]
KapSkinnableContainer
  
setStyle(styleProp:String, newValue:*):void
[override]
PictogramChart
  
styleChanged(styleProp:String):void
[override]
PictogramChart
  
unregisterAction(actionID:String):void
Unregisters an already registered action.
PictogramChart
  
Unregister all actions.
PictogramChart
  
updateAction(actionID:String, data:Object = null):void
Updates an action parameter given its id via a new data instance.
PictogramChart
  
Updates cells visual content and filtering effect according to its data and percentage value.
PictogramChart
Protected Methods
 MethodDefined By
  
Handles data conversion into cells.
PictogramChart
  
[override]
PictogramChart
  
handlePictogramResize(event:ResizeEvent):void
Handles component resize.
PictogramChart
  
init():void
Initializes skin, listeners, actions, layout and sizes at construction time.
PictogramChart
  
Initializes KapData parsing parameters.
PictogramChart
  
initLayout():void
Initializes default tile layout.
PictogramChart
  
Initializes actions managers.
PictogramChart
  
initSkin():void
Initializes skin class.
PictogramChart
 Inherited
loadKData():void
Generate a common data descriptor from the dataProvider and other data manipulation options.
KapSkinnableContainer
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
PictogramChart
Styles
 Style Description Defined By
  
cellGridPercentHeight
Type: Number
Cell Grid height percentage according to the total cell width.

The style value is used exclusively with the default PictogramCell skin. The residual height amount will be the valueLabel and metaDataLabel height.

The default value is 90.

See also

PictogramChart
  
cellGridPercentWidth
Type: Number
Cell Grid width percentage according to the total cell width.

The style value is used exclusively with the default PictogramCell skin. The residual width amount will be the symbolArea and metaDataLabel width.

The default value is 70.

See also

PictogramChart
  
cellHeight
Type: Number
Height to be assigned to each cell in the chart. If not mentionned, the tile layout, used to position cells, computes and assigns an adequate height for each cell in order to justify the fully-visible cells to the Pictogram height.

The style value is used exclusively when no other spark TileLayout is affected to the layout property of this component.

The default value is 0.

See also

PictogramChart
  
cellHorizontalSpacing
Type: Number
Cell internal horizontal spacing.

The style value is used exclusively with the default PictogramCell skin.

The default value is 20.

See also

PictogramChart
  
cellSkinClass
Type: Class
Name of the skin class to use for each cell in the chart. The skin must be a class that extends UIComponent.
PictogramChart
  
cellVerticalSpacing
Type: Number
Cell internal vertical spacing.

The style value is used exclusively with the default PictogramCell skin.

The default value is 10.

See also

PictogramChart
  
cellWidth
Type: Number
Width to be assigned to each cell in the chart. If not mentionned, the tile layout, used to position cells, computes and assigns an adequate width for each cell in order to justify the fully-visible cells to the Pictogram width.

The style value is used exclusively when no other spark TileLayout is affected to the layout property of this component.

The default value is 0.

See also

PictogramChart
  
columnCount
Type: Number
Actual column count of the TileLayout used with this component.

The style value is used exclusively when no other spark TileLayout is affected to the layout property of this component.

The default value is 4.

See also

PictogramChart
  
columnCountReference
Type: Number
Reference column count of the TileLayout used with this component. It is used to specify a default configuration of the Pictogram and to let a ratioX computed for each cell according to this default configuration. Thus, cell skins can adapt their content (Font and graphical artefacts) to a different columnCount or columnWidth.

In general, columnCountReference rowCountReference is equal to the number of cells or the number of the dataProvider entries. This configuration referes to a ratioX and ratioY equal to 1.

If not mentionned, ratio values will be not computed on each cell and thus cannot be used in the cell skins

The default value is -1.

See also

PictogramChart
  
horizontalGap
Type: Number
Horizontal space between cells, in pixels.

The style value is used exclusively when no other spark TileLayout is affected to the layout property of this component.

The default value is 5.

See also

PictogramChart
  
rowCount
Type: Number
Actual column count of the TileLayout used with this component.

The style value is used exclusively when no other spark TileLayout is affected to the layout property of this component.

The default value is 4.

See also

PictogramChart
  
rowCountReference
Type: Number
Reference row count of the TileLayout used with this component. It is used to specify a default configuration of the Pictogram and to let a ratioY computed for each cell according to this default configuration. Thus, cell skins can adapt their content (Font and graphical artefacts) to a different rowCount or rowHeight.

In general, columnCountReference rowCountReference is equal to the number of cells or the number of the dataProvider entries. This configuration referes to a ratioX and ratioY equal to 1.

If not mentionned, ratio values will be not computed on each cell and thus cannot be used in the cell skins

The default value is -1.

See also

PictogramChart
  
unitAlphaCoding
Type: Boolean
Specifies if any percentage value for each unit in a cell grid will be coded in its alpha value. For example, if a unit value is equal to x (between 0 and 1), the alpha value of that unit will be equal to x.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is 0x2385C4.

See also

PictogramChart
  
unitBackgroundAlphas
Type: Array
Background alphas for each unit in a cell grid.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is [1,1].

See also

PictogramChart
  
unitBackgroundColors
Type: Array
Background colors for each unit in a cell grid.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is [0x2385C4,0x1B66AF].

See also

PictogramChart
  
unitHorizontalGap
Type: Number
Horizontal Gap between cell grid units.

The style value is used exclusively with the default PictogramCell skin.

The default value is 5.

See also

PictogramChart
  
unitLineAlpha
Type: Number
Line alpha for each unit in a cell grid.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is 0.4.

See also

PictogramChart
  
unitLineColor
Type: uint
Line color for each unit in a cell grid.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is 0x2385C4.

See also

PictogramChart
  
unitLineThickness
Type: uint
Line thickness for each unit in a cell grid.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is 2.

See also

PictogramChart
  
unitMinSize
Type: Number
Minimum size of each cell grid unit.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is 5.

See also

PictogramChart
  
unitRoundRadius
Type: Number
Round radius for each unit in a cell grid.

The style value is used exclusively when no unitItemRenderer or unitItemRendererFunction is specified.

The default value is 5.

See also

PictogramChart
  
unitVerticalGap
Type: Number
Vertical Gap between cell grid units.

The style value is used exclusively with the default PictogramCell skin.

The default value is 5.

See also

PictogramChart
  
verticalGap
Type: Number
Vertical space between cells, in pixels.

The style value is used exclusively when no other spark TileLayout is affected to the layout property of this component.

The default value is 5.

See also

PictogramChart
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
contentScroller:spark.components.Scroller
Required: false Part Type: Static
A skin part that defines a scroller controlling the contentGroup of the skin. The scroller will be used for panning purposes. Generally, the contentScroller is defined in the Pictogram skin with the contentGroup as viewport.
PictogramChart
Public Constants
 ConstantDefined By
 InheritedBICHROMATIC_COLORING : String = bichromatic
[static]
KapSkinnableContainer
 InheritedDEFAULT_COLORING : String = none
[static]
KapSkinnableContainer
 InheritedMONOCHROMATIC_COLORING : String = monochromatic
[static]
KapSkinnableContainer
 InheritedUNIFORM_COLORING : String = uniform
[static]
KapSkinnableContainer
Property Detail
_dataChangedproperty
protected var _dataChanged:Boolean = true

Flag indicating that Pictogram data has changed.

_enableRoundedPercentagesproperty 
protected var _enableRoundedPercentages:Boolean = false

Flag indicating that percentages rounding policy has changed. It is taken into account at invalidation process.

_unitRendererChangedproperty 
protected var _unitRendererChanged:Boolean = true

Flag indicating that unit renderers has changed. It is taken into account at invalidation process.

actionsPackagerproperty 
actionsPackager:IActionPackage

A packager used by Pictogram to activate new actions instead for the actual ones.


Implementation
    public function get actionsPackager():IActionPackage
    public function set actionsPackager(value:IActionPackage):void
cellsproperty 
public var cells:Array

List of PictogramCell instances added to the Pictogram contentGroup.

enableRoundedPercentagesproperty 
enableRoundedPercentages:Boolean

Flag indicating, if set to true, that percentages should be rounded to 0 or 1 and cell grid units should be filled accordingly.

The default value is false.


Implementation
    public function get enableRoundedPercentages():Boolean
    public function set enableRoundedPercentages(value:Boolean):void
filterAlphaproperty 
filterAlpha:Number

The alpha of faded cells which value is not on values range defined by valueFilters.

If valueField isn't mentionned, the property value isn't taken into account


Implementation
    public function get filterAlpha():Number
    public function set filterAlpha(value:Number):void

See also

metaDataFieldproperty 
metaDataField:String

Cell data property which value is assigned to the metaDataLabel skin part of any PictogramCell (if the skin part exists).


Implementation
    public function get metaDataField():String
    public function set metaDataField(value:String):void
percentageFunctionproperty 
percentageFunction:Function

Function returning the percentage value from a data entry or cell data. If set to null, a default percentage function is used (divising the value by the maximum value in the data entries).

The returned percentage value should be between 0 and 1. The unitsGrid is filled according to that value.

		 private var maxValue = 250;
		 function getPercentage(item:Object):Number
		 {
		 	return item.salesAmount/maxValue;
		 }
		 


Implementation
    public function get percentageFunction():Function
    public function set percentageFunction(value:Function):void
symbolFieldproperty 
symbolField:String

Cell data property which value is assimilated as the source property of the symbolArea skin part of any PictogramCell (if the skin part exists). The value of this property should be compatible with the source of a BitmapData.


Implementation
    public function get symbolField():String
    public function set symbolField(value:String):void
unitColumnCountproperty 
unitColumnCount:uint

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Actual column count of the TileLayout used with the unitsGrid skin part in any cell.

The style value is used exclusively when no new cell skin is defined via cellSkinClass style property.

The default value is 4.


Implementation
    public function get unitColumnCount():uint
    public function set unitColumnCount(value:uint):void
unitFillPolicyproperty 
unitFillPolicy:String

Fill policy of the cell grid units according to percentage value. This is important when using custom spark layouts on the unitsGrid skin part from an aesthetic point of view.

The default value is fillBottomToTop.


Implementation
    public function get unitFillPolicy():String
    public function set unitFillPolicy(value:String):void

See also

unitItemRendererproperty 
unitItemRenderer:Class

Cell grid unit renderer class. For each unit in any cell grid, an instance of this class is added.

The renderer class must implement the IPictogramUnit. According to the percentage value, its aspect (fill amount for example) shoud be updated.


Implementation
    public function get unitItemRenderer():Class
    public function set unitItemRenderer(value:Class):void

See also

unitItemRendererFunctionproperty 
unitItemRendererFunction:Function

Cell grid unit renderer function. The function has as arguments the percentage value and then the cell data to return the IVisualElement instance. This instance is added to the unitsGrid skin part of any cell.

The returned instance must implement the IPictogramUnit interface. According to the percentage value, its aspect (fill amount for example) shoud be updated.


Implementation
    public function get unitItemRendererFunction():Function
    public function set unitItemRendererFunction(value:Function):void

See also

unitRowCountproperty 
unitRowCount:uint

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Actual row count of the TileLayout used with the unitsGrid skin part in any cell.

The style value is used exclusively when no new cell skin is defined via cellSkinClass style property.

The default value is 4.


Implementation
    public function get unitRowCount():uint
    public function set unitRowCount(value:uint):void
valueFieldproperty 
valueField:String

Cell data property which value is assigned to the valueLabel skin part of any PictogramCell (if the skin part exists). Defining valueField is mandatory if filtering by value is required from a functional point of view via valueFilters property or if no percentageFunction is defined.


Implementation
    public function get valueField():String
    public function set valueField(value:String):void

See also

valueFiltersproperty 
valueFilters:Array

A Array containing the min and max of cell values. The cells contained in that range are highlighted by maintaining their alpha to 1, the others are faded via an alpha value equal to the filterAlpha value.

If valueField isn't mentionned, the property value isn't taken into account


Implementation
    public function get valueFilters():Array
    public function set valueFilters(value:Array):void

See also

valueLabelFunctionproperty 
valueLabelFunction:Function

Function returning a String value from cell data. The result is assigned to the valueLabel skin part of any PictogramCell (if the skin part exists).


Implementation
    public function get valueLabelFunction():Function
    public function set valueLabelFunction(value:Function):void
Constructor Detail
PictogramChart()Constructor
public function PictogramChart()

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Method Detail
activateAction()method
public function activateAction(actionID:String, data:Object = null):void

Activates an already registered action by calling the activate method on the concerned action instance. Generally, an action is activated by adding its event listeners and other processing to perform a required user interaction scenario.

Parameters

actionID:String — Unique Id of the action to be activated.
 
data:Object (default = null) — Custom action data containing new action parameters. If set to null, already used parameters are considered.

See also

commitDataProvider()method 
protected function commitDataProvider():void

Handles data conversion into cells. Cells are added to the component in this function.

commitProperties()method 
override protected function commitProperties():void

deactivateAction()method 
public function deactivateAction(actionID:String):void

Deactivates an already registered and activated action by calling the deactivate method on the concerned action instance. Generally, an action is deactivated by removing its event listeners and internal maps.

Parameters

actionID:String — Unique Id of the action to deactivate.

See also

deactivateAllActions()method 
public function deactivateAllActions():void

Deactivates all actions in Pictogram.

See also

getActionData()method 
public function getActionData(actionID:String):Object

Returns action parameters as a typed object. The data object is compatible with the layout, thus it should be casted to the correct Class.

Parameters

actionID:String — Unique ID of the action for which parameters are returned.

Returns
Object — Typed data object used as parameters descriptor in the action instance.
getActionInstance()method 
public function getActionInstance(actionID:String):IAction

Returns action instance. This function should be used in very specific conditions.

Parameters

actionID:String — Unqiue ID of the action.

Returns
IAction — Action Instance. If the action isn't registered, the returned value is null.
getActionStatus()method 
public function getActionStatus(actionID:String):String

Returns action status given its id. Three action statuses are possible:

Parameters

actionID:String — Unique ID of the action to check.

Returns
String — referenced action status (UNREGISTERED, ACTIVATED, DEACTIVATED or HIBERNATED)

See also

getPercentage()method 
pictogram_internal function getPercentage(item:Object):Number

Default percentage function. The returned value is equal to the value extracted from the item is divided by the sum of all data provider values.

Parameters

item:Object — Cell data

Returns
Number — Percentage value.
getStyle()method 
override public function getStyle(styleProp:String):*

Parameters

styleProp:String

Returns
*
handlePictogramResize()method 
protected function handlePictogramResize(event:ResizeEvent):void

Handles component resize.

Parameters

event:ResizeEvent

hasAction()method 
public function hasAction(actionID:String):Boolean

Checks if an action ID is already registered.

Parameters

actionID:String — Unique ID of the action to check.

Returns
Boolean — If true, the concerned Unique ID is already registered and refers to a given action.

See also

hibernateAction()method 
public function hibernateAction(actionID:String):void

Performs partial action deactivation for sooner re-activation. This method is used when using exclusive actions that need to be run exclusively without no execution concurrence. When an action is hibernated, internal status and other properties will still be stored to be taken into account after re-activation.

Parameters

actionID:String — Unique Id of the action to hibernate.

init()method 
protected function init():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Initializes skin, listeners, actions, layout and sizes at construction time.

initDataParams()method 
protected function initDataParams():void

Initializes KapData parsing parameters.

initLayout()method 
protected function initLayout():void

Initializes default tile layout.

initManagers()method 
protected function initManagers():void

Initializes actions managers.

initSkin()method 
protected function initSkin():void

Initializes skin class.

messageAction()method 
public function messageAction(actionID:String, message:Object):void

Routes a message object to a given action instance given its ID. This technique is used to synchronize between some actions (e.g Keyboard Action, Panning Action, Zoom Action) with the required data.

Here are some examples where messaging actions is important especially for custom actions you may develop:

Parameters

actionID:String — Unique ID of the action to check.
 
message:Object — Message object to be consumed by the concerned action.

messageAllActions()method 
public function messageAllActions(message:Object):void

Routes a Pictogram message to all activated actions.

Parameters

message:Object — Message object to be consumed by interested actions.

See also

panContent()method 
public function panContent(displacementX:Number, displacementY:Number):void

Pans the content of the Pictogram if its content is greater that the Pictogram visual viewport. The Pictogram should be scrollable in that case.

Parameters

displacementX:Number — displacement value by X.
 
displacementY:Number — displcement value by Y.

registerAction()method 
public function registerAction(actionClass:Class, isActivated:Boolean = false, data:Object = null):void

Registers a new action class modelizing a user interaction scenario. When registering an action, a unique instance of this action will be created. Its unique id will be the key for accessing this instance. If the registered action has an id already registered,,the already registered action will be replaced by the new action class.

The action class must implement the IAction interface in order to let Pictogram perform common operations:

It is recommended to extend the Action class which contains basic implementation of the IAction interface that should be overriden.

Parameters

actionClass:Class — Action class to be registered. This class must implement the IAction class.
 
isActivated:Boolean (default = false) — If set to true, after registering the action class, the created action instance will be activated to be operational.
 
data:Object (default = null) — Custom action data containing action parameters. If set to null, default action parameters will be used.

See also

registerActionPackage()method 
public function registerActionPackage(newActionPackager:IActionPackage, reset:Boolean = false):void

Register a set of actions packaged in action sets (a set of ActionSet instances). These actions will be deployed, registered and event activated according to the action sets content.

Parameters

newActionPackager:IActionPackage — The action package instance.
 
reset:Boolean (default = false) — If set to true, all actions will be replaced by the content of the actions package. If not, the actions will be added to the current Pictogram actions.

registerActionSet()method 
public function registerActionSet(actionSet:ActionSet):void

Register a given action set in the Pictogram based on its properties. This method calls the registerAction method for this purpose.

Parameters

actionSet:ActionSet — The action set containing the action configuration information.

setStyle()method 
override public function setStyle(styleProp:String, newValue:*):void

Parameters

styleProp:String
 
newValue:*

styleChanged()method 
override public function styleChanged(styleProp:String):void

Parameters

styleProp:String

unregisterAction()method 
public function unregisterAction(actionID:String):void

Unregisters an already registered action. If the action is already activated, it will be deactivated before removing its references in Pictogram and all its parameters.

Parameters

actionID:String — Unique Id of the action to remove.

See also

unregisterAll()method 
public function unregisterAll():void

Unregister all actions.

updateAction()method 
public function updateAction(actionID:String, data:Object = null):void

Updates an action parameter given its id via a new data instance. The data will be set via the data property of the referenced action, thus it is important that the input is recognizable by the concerned action.

For example, when updating the displace action (DisplaceAction.ID), the data must be an instance of DisplaceActionData.

Parameters

actionID:String — Unique Id of the action to update.
 
data:Object (default = null) — Custom action data containing new action parameters and compatible with the referenced action itself.

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number

updatePercentages()method 
public function updatePercentages():void

Updates cells visual content and filtering effect according to its data and percentage value.