Packagecom.kapit.visualizer
Classpublic class Visualizer
InheritanceVisualizer Inheritance fr.kapit.licence.KapCanvas
ImplementsIGenericItem

Visualizer is an innovant component that helps flex developpers and enterprises to display, analyse and organize any data or information. It handles the reading, analysis, visual rendering and organisation of XML and CSV files and ICollectionView instances (Hierarchical). Using a custom parsing methods and graph layouts for visual organisation, any data can be clearly and properly read and interpreted. The component shares several options for user interaction and visual organisation that can be easily customized.

Default MXML PropertydataProvider



Public Properties
 PropertyDefined by
  analysisPath : Object
Analysis Path is used for CSV and General XML files and enables data source analysis with a given logic.
Visualizer
  attributesDescriptor : AttributesDescriptor
It assigns to each column reference in the analysisPath its attributes.
Visualizer
  balloonLayout : BalloonLayout
Visualizer Balloon Layout.
Visualizer
  biHierarchicalLayout : BiHierarchicalLayout
Visualizer BiHierarchcal Layout.
Visualizer
  buttonPlacement : String
Expand Collapse Button Placement.
Visualizer
  circularLayout : SingleCycleCircularLayout
Visualizer Circular Layout.
Visualizer
  clickLinkStyle : Object
Link Style at Click.
Visualizer
  clickLinkStyleFunction : Function
Link Style Function at Click that can be used to renderer links by consumin the source and target nodes data.
Visualizer
  clickNodeFilters : Array
Node Filters at Click.
Visualizer
  collapseButtonClass : Class
Collapse Icon shown when the node is expanded.
Visualizer
  collapseOverButtonClass : Class
Collapse Icon shown when the node is expanded and the Expand/Collapse Button is rolled over.
Visualizer
  collpaseOverButtonClass : Class
Visualizer
  colorFields : Array
Colors for an analysisPath elements.
Visualizer
  coloringFunction : Function
Coloring function will set a given background color to any element by applying it.
Visualizer
  coloringPolicy : String
Coloring policy used to designate layers elements or to differentiate GenericSprite elements.
Visualizer
  csvDelimiter : String
CSV delimiter.
Visualizer
  customTreeDataDescriptor : ITreeDataDescriptor
Custom Tree Data descriptor for navigating inside data provider object.
Visualizer
  dataProvider : Object
Visualizer Data provider.
Visualizer
  defaultNodeHeight : Number
Default node height used when using custom multimediaClass.
Visualizer
  defaultNodeWidth : Number
Default node width used when using custom multimediaClass.
Visualizer
  enablePan : Boolean
Indicator if panning the Visualizer content should be enabled.
Visualizer
  enableSelectionDrag : Boolean
Indicator if selected elements can be dragged.
Visualizer
  enableZoomOnMouseWheel : Boolean
Indicator if the visualizer content should be zoomed on wheel event.
Visualizer
  expandButtonClass : Class
Expand Icon shown when the node is collapsed.
Visualizer
  expandOnDoubleClick : Boolean
Indicator if elements with Expand (or Collapse) status should be collapsed (or expanded) by double click.
Visualizer
  expandOverButtonClass : Class
Expand Icon shown when the node is collapsed and the Expand/Collapse Button is rolled over.
Visualizer
  expandPolicy : uint
Current Expand Policy used in the Visualizer.
Visualizer
  firstColor : uint
First extremity of the Bichromatic color sequence and used color for Monochromatic coloring.
Visualizer
  graphItems : Dictionary
[read-only] Dictionary containing all graph elements (Links and Nodes).
Visualizer
  hideTooltipDelay : Number
Delay used for tooltip show.
Visualizer
  hierarchicalCyclicLayout : SugiyamaLayout
Visualizer Hierarchical Cyclic Layout.
Visualizer
  hierarchicalTreeLayout : HierarchicalLayout
Visualizer Hierarchical Tree Layout.
Visualizer
  highlightLinkStyle : Object
Link Style at Roll Over.
Visualizer
  highlightLinkStyleFunction : Function
Link Style Function at Roll Over that can be used to renderer links by consumin the source and target nodes data.
Visualizer
  highlightNodeFilters : Array
Node Filters at Roll Over.
Visualizer
  highlightPolicy : uint
Indicator for the Highlight policy that can be used.
Visualizer
  idleLinkStyle : Object
Link Style that can be used to renderer links.
Visualizer
  idleLinkStyleFunction : Function
Link Style Function that can be used to renderer links by consumin the source and target nodes data.
Visualizer
  idleNodeFilers : Array
Node Filters at Idle status.
Visualizer
  ignoreRoot : Boolean
Indicator if common root node of ICollectionView should be ignored.
Visualizer
  labelFieldFunction : Function
Label Function used to extract specific data in order to be displayed in each Sprite element.
Visualizer
  labelFields : Object
Sprites label Fields.
Visualizer
  labelFontColor : uint
Label Font color.
Visualizer
  labelFontFamily : String
label font family.
Visualizer
  labelLinkFieldFunction : Function
Label Function used to extract specific data in order to be displayed in each Link element.
Visualizer
  labelLinkFields : Object
Links label Fields.
Visualizer
  labelLinkFontColor : uint
Label Font color.
Visualizer
  labelLinkFontFamily : String
label link font family.
Visualizer
  labelLinkTitleFontColor : uint
Label Font color.
Visualizer
  labelLinkTitles : Object
Titles to be displayed when using the DefaultItemRender.
Visualizer
  labelTitleFontColor : uint
Label Font color.
Visualizer
  labelTitles : Object
Titles to be displayed when using the DefaultItemRender.
Visualizer
  layout : Object
Default visualizer layout Index.
Visualizer
  LayoutClass : Layout
[read-only] Current graph Layout class.
Visualizer
  linkStyle : Object
Link Style used to draw links.
Visualizer
  maintainAspectRatio : Boolean
Maintain aspect ratio for Image Item Renderers.
Visualizer
  maxLevel : uint
[read-only] Maximum level number of all hierarchies.
Visualizer
  mergeDescriptor : MergeDescriptor
This Class instance defines merging tasks that must be applied on a CSV source before displaying it.
Visualizer
  mindMapLayout : MindMapLayout
Visualizer Mind Map Layout suited for mind maps.
Visualizer
  mindMapOrientationFunction : Function
Function specifying the orientation (right, left, top, bottom) for each node in the Visualizer Graph.
Visualizer
  multimediaClass : Class
Image, Video or custom visual class that extends the DisplayObject class.
Visualizer
  multimediaDataSource : Object
multimediaDataSource specifies the data needed by the multimediaClass.
Visualizer
  multimediaFunction : Function
MultimediaData extraction Function used to extract specific multimedia (image, video...) in order to be displayed in each Sprite element.
Visualizer
  multimediaLinkClass : Class
Image, Video or custom visual class that extends the DisplayObject class.
Visualizer
  multimediaLinkDataSource : Object
multimediaLinkDataSource specifies the data needed by the multimediaLinkClass.
Visualizer
  multimediaLinkFunction : Function
MultimediaLinkData extraction Function used to extract specific multimedia (image, video...) in order to be displayed in each link element.
Visualizer
  nodeZoomFactor : Number
Zoom Node Factor.
Visualizer
  normalizeNodesSize : Boolean
Indicator if node sizes should be uniformized.
Visualizer
  orthogonalLayout : OrthogonalLayout
Visualizer Orthogonal Layout.
Visualizer
  radialLayout : RadialLayout
Visualizer Radial Layout.
Visualizer
  ratio : Number
[read-only] Current zoom ratio.
Visualizer
  recordDelimiter : String
Record delimiter of CSV fields.
Visualizer
  reportingFunctions : Dictionary
Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment.
Visualizer
  secondColor : uint
Second extremity of the Bichromatic color sequence.
Visualizer
  showExpandCollapseButton : Boolean
Indicator if default Expand/Collapse Buttons should be disabled.
Visualizer
  showLinkLabelsAtClick : Boolean
Indicator if Link Decorators should be shown only on a clicked item links.
Visualizer
  staticOrganicLayout : StaticGEMLayout
Visualizer Organic Layout.
Visualizer
  status : uint
[read-only] Indicates Visualizer status.
Visualizer
  toolTipFieldFunction : Function
Tooltip Function used to extract specific data in order to be displayed in each Sprite element.
Visualizer
  tooltipFields : Object
Sprites tooltip Fields.
Visualizer
  tooltipFontColor : uint
Tootltip font color.
Visualizer
  tooltipFontFamily : String
Tootltip font family.
Visualizer
  toolTipLinkFieldFunction : Function
Tooltip Function used to extract specific data in order to be displayed in each Link element.
Visualizer
  tooltipLinkFields : Object
Links tooltip Fields.
Visualizer
  tooltipLinkFontColor : uint
Tooltip Link Font color.
Visualizer
  tooltipLinkRendererFunction : Function
Tooltip Function used define a custom tooltip renderer for link.
Visualizer
  tooltipLinkTitleFontColor : uint
Tooltip Title Link Font color.
Visualizer
  toolTipLinkTitles : Object
ToolTips to be activated when using the DefaultItemRenderer.
Visualizer
  tooltipRendererFunction : Function
Tooltip Function used define a custom tooltip renderer for sprite node.
Visualizer
  tooltipTitleFontColor : uint
Tootltip Title font color.
Visualizer
  toolTipTitles : Object
ToolTips to be activated when using the DefaultItemRender.
Visualizer
  typesDescriptor : Dictionary
Column types descriptor.
Visualizer
  UID : String
[read-only] Component UID.
Visualizer
  uniformColor : uint
Default color used with Default item renderer.
Visualizer
  useMultiLink : Boolean
Visualizer
  visibilityLevel : int
Visiblity Level of the generated graph.
Visualizer
  withHeaders : Boolean
Indicator if CSV file first row are headers or not.
Visualizer
  zoomNodeNodeOnRollOver : Boolean
[write-only]
Visualizer
  zoomNodeOnRollOver : Boolean
[read-only] Zoom Node on Roll Over.
Visualizer
Protected Properties
 PropertyDefined by
  collapsedElementsMap : Dictionary
Visualizer
Public Methods
 MethodDefined by
  
Constructor.
Visualizer
  
addLinkElement(data:Object, sourceObject:GenericObject, targetObject:GenericObject, uid:String = null, linkStyle:Object = null, isGML:Boolean = false, updateStructure:Boolean = false):GenericLink
Add link to the graph.
Visualizer
  
addNodeElement(data:Object, parentExpandSprite:GenericSprite = null, position:Point = null, uid:String = null, isGML:Boolean = false, updateStructure:Boolean = false):GenericSprite
Add a Node to the Graph with respect to Expand/Collapse policy
Visualizer
  
autoFit(withAnimation:Boolean = true, duration:uint = 1000, horizontalGap:Number = 30, verticalGap:Number = 30, layoutDependant:Boolean = false, ratioNotLessThanOne:Boolean = true):void
Fits the Visualizer content to the visible region.
Visualizer
  
centerContent(withAnimation:Boolean = true):void
Centers the content of the visualizer.
Visualizer
  
enters a given Node on the Visualizer component center.
Visualizer
  
centerNodes(sprites:Array):void
enters a set of Nodes on the Visualizer component center.
Visualizer
  
getBitmapData(width:Number, height:Number):BitmapData
Visualizer
  
Reloads Link Style according to the Style Objects content and forces links redraw.
Visualizer
  
Reloads Node Style according to the Style Objects content and forces Nodes filters re-application.
Visualizer
  
panContentBy(deltaX:Number, deltaY:Number, ratio:Number = 1, withAnimation:Boolean = false):void
Move the content of the Visualizer by deltaX in the XAxis and deltaY in the YAxis while applying a zoom effect given the ratio.
Visualizer
  
panContentTo(point:Point, startPoint:Point = null, ratio:Number = 1, withAnimation:Boolean = false):void
Pans the content of the Visualizer to a new Position from a StartPoint (Control Point).
Visualizer
  
reLayout(fixedElement:GenericSprite = null):void
Performs another layout computation.
Visualizer
  
removeAll():void
Remove all Items of the Graph in the Visualizer.
Visualizer
  
removeLinkElement(uid:String = null, noEvent:Boolean = false):void
Remove a Link element from the Graph given its unique ID.
Visualizer
  
removeLinkElementInstance(link:GenericLink, noEvent:Boolean = false):void
Remove a Link element from the Graph given its unique ID.
Visualizer
  
removeNodeElement(uid:String = null, removeChildren:Boolean = true, noEvent:Boolean = true):void
Remove Node from the Visualizer given its unique id.
Visualizer
  
searchElement(searchKey:String, filters:Array = null, property:String = null, byID:Boolean = false, centerResult:Boolean = true, expand:Boolean = true):Array
Search for Elements given a search key and property and apply a filter on the found ones.
Visualizer
  
Visualizer
  
Updates SubGraphs and Hierarchies computation.
Visualizer
  
Refreshe All Links Style and Link Decorators.
Visualizer
  
Refresh a Link Style and Link Decorator.
Visualizer
  
Shows or hides Nodes Expand/Collapse Button.
Visualizer
  
Updates Node size according to NormalizeNodesSize property.
Visualizer
  
Invalidates Nodes Styles and updates filters and visual properties of the Visualizer.
Visualizer
  
zoomContent(ratio:Number, zoomPosition:Point = null, relativeZoom:Boolean = true, withAnimation:Boolean = true, duration:uint = 1000):void
Performs a zoom on the Visualizer given a zoom ratio and its relativity.
Visualizer
Protected Methods
 MethodDefined by
  
inheritDoc
Visualizer
  
Visualizer
  
handleResize(event:ResizeEvent):void
Visualizer
  
measure():void
Visualizer
Events
 EventSummaryDefined by
   Indicates that the Visualizer content animation has ended.Visualizer
   Indicates that the Visualizer data input has been loaded and rendered.Visualizer
   Indicates that an element has been clicked.Visualizer
   Indicates that an element has been Collapsed.Visualizer
   Indicates that an element has been double clicked.Visualizer
   Indicates that an element has been Expanded.Visualizer
   Indicates that an element is being rolled out.Visualizer
   Indicates that an element is being rolled over.Visualizer
   Indicates that the user stopped dragging elements.Visualizer
   Indicates that the user starts dragging an element.Visualizer
   Indicates All elements which Expand/Collapse Status have been changed.Visualizer
   Indicates that the user has started scrolling inside the visualizer Visualizer
   Indicates that the user has ended a scrolling operation inside the visualizer.Visualizer
   Indicates that the visibility level has been changed.Visualizer
Public Constants
 ConstantDefined by
  ANIMATING_STATUS : uint = 1
[static] ANIMATING Visualizer status.
Visualizer
  BALLOON_LAYOUT : uint = 3
[static] Balloon Layout Index.
Visualizer
  BICHROMATIC_COLORING : String = "bichromatic"
[static] Bichromatic coloring policy.
Visualizer
  BIHIERARCHICAL_LAYOUT : uint = 9
[static] BiHierarchical Layout Index
Visualizer
  BUSY_STATUS : uint = 4
[static] BUSY Visualizer status.
Visualizer
  CENTER_GRAPH_ON_EXPAND : uint = 0
[static] Expand Policy indicating that the graph should be centered after Expand.
Visualizer
  CENTER_NODE_ON_EXPAND : uint = 2
[static] Expand Policy indicating that the expanded node should be centered after expand.
Visualizer
  CIRCULAR_BASED_HIGHLIGHT : uint = 0
[static] Circular Highlight Policy constant.
Visualizer
  CIRCULAR_LAYOUT : uint = 0
[static] Circular Layout Index.
Visualizer
  DEFAULT_COLOR : uint = 0xCEB8AE
[static] Default color used on Uniform coloring mode (used with DefaultItemRenderer).
Visualizer
  DEFAULT_FIRST_COLOR : uint = 0x145363
[static] Default First color extremity used on Bichromatic coloring mode (used with DefaultItemRenderer and Hierarchical data structure).
Visualizer
  DEFAULT_NODE_HEIGHT : Number = 20
[static] Default Item Height.
Visualizer
  DEFAULT_NODE_WIDTH : Number = 20
[static] Default Item Width.
Visualizer
  DEFAULT_NODE_ZOOM_FACTOR : Number = 1.4
[static] Default Node Zoom at Highlight
Visualizer
  DEFAULT_SECOND_COLOR : uint = 0xC9C5FC
[static] Default Last color extremity used on Bichromatic coloring mode (used with DefaultItemRenderer and Hierarchical data structure).
Visualizer
  FILTER_BASED_HIGHLIGHT : uint = 1
[static] Filter based Highlight Policy constant.
Visualizer
  FIX_NODE_ON_EXPAND : uint = 1
[static] Expand Policy indicating that the expanded node should be fixed after expand.
Visualizer
  HIERARCHICAL_CYCLIC_LAYOUT : uint = 4
[static] Sugiyama Layout Index.
Visualizer
  HIERARCHICAL_TREE_LAYOUT : uint = 1
[static] Hierarchical Layout Index.
Visualizer
  IDLE_STATUS : uint = 0
[static] IDLE Visualizer status.
Visualizer
  MINDMAP_LAYOUT : uint = 8
[static] MindMap Layout Index.
Visualizer
  MONOCHROMATIC_COLORING : String = "monochromatic"
[static] Monochromatic coloring policy.
Visualizer
  ORTHOGONAL_LAYOUT : uint = 7
[static] Orthogonal Layout Index.
Visualizer
  PAN_STATUS : uint = 2
[static] Pan Visualizer status.
Visualizer
  RADIAL_LAYOUT : uint = 2
[static] Radial Layout Index.
Visualizer
  SELECTION_MOVE_STATUS : uint = 3
[static] Selection Move Visualizer status.
Visualizer
  STATIC_ORGANIC_LAYOUT : uint = 5
[static] GEM Layout Index.
Visualizer
  UNIFORM_COLORING : String = "none"
[static] Uniform coloring policy.
Visualizer
Property detail
analysisPathproperty
analysisPath:Object  [read-write]

Analysis Path is used for CSV and General XML files and enables data source analysis with a given logic. For CSV files, the analysis path is an Array containing the considered columns headers in the same order of the required analysis logic. For ICollectionView instances and Objects with children property, the analysis path is an Array containing the considered attributes in the same order of the required analysis logic. The String representation of that Array is also handled (visualizer.analysisPath=prop1;prop2) This property can be used as the source for data binding.

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

Implementation
    public function get analysisPath():Object
    public function set analysisPath(value:Object):void

Example
Given the following CSV file, one of the analysis Paths should be ["Entreprise", "Departement", "ID"], the delimiter should be "," and the record delimiter should be "/"". "Entreprise","Departement","ID" "Enterp","D1","D11" "Enterp","D1","D12" "Enterp","D1","D13" "Enterp","D2","D21" "Enterp","D2","D22" "Enterp","D3","D31" ...

attributesDescriptorproperty 
attributesDescriptor:AttributesDescriptor  [read-write]

It assigns to each column reference in the analysisPath its attributes. By default, Each field of an analysisPath column header have as attributes the other column headers of the CSV input. attributesDescriptor specifies the content and properties of extracted data sets.

The default value is null.

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

Implementation
    public function get attributesDescriptor():AttributesDescriptor
    public function set attributesDescriptor(value:AttributesDescriptor):void

Example
//Assuming a CSV that have six columns ( "Entreprise", "Name", "Departement", "Technology", "Name", "Holidays") //and that we have specified ["Entreprise", "Name", "Departement"] as an analysisPath, we want to specify for each element extracted from a //column reference in the buildPath, its properties and data content. The following snippet shows how attributesDescriptor solves the problem. kData.buildPath=["Entreprise", "Name", "Departement"]; var attributesDescriptor:AttributesDescriptor=new AttributesDescriptor(); // Creation of the _Attributes var attributesEntity1:AttributesEntity=new AttributesEntity("Entreprise",["Technology","Age"]); // Data sets generated from the analysis of _Entreprise_ column have only _Technology_ and _Age_ properties var attributesEntity2:AttributesEntity=new AttributesEntity("Name",["Holidays"]); // Data sets generated from the analysis of _Name_ column have only _Holidays_ properties var attributesEntity3:AttributesEntity=new AttributesEntity("Departement",["Age"]); // Data sets generated from the analysis of _Department_ column have only _Age_ properties attributesDescriptor.AddAttributesDescription(attributesEntity1); // Adding AttributesEntity instances to the _AttributesDescriptor_ instance attributesDescriptor.AddAttributesDescription(attributesEntity2); attributesDescriptor.AddAttributesDescription(attributesEntity3); myVisualizer.attributesDescriptor=attributesDescriptor; // registering the created _AttributesDescriptor_ instance in _Visualizer_instance.

balloonLayoutproperty 
balloonLayout:BalloonLayout  [read-write]

Visualizer Balloon Layout. It is shared in order to let developper change this layout options.

Implementation
    public function get balloonLayout():BalloonLayout
    public function set balloonLayout(value:BalloonLayout):void
biHierarchicalLayoutproperty 
biHierarchicalLayout:BiHierarchicalLayout  [read-write]

Visualizer BiHierarchcal Layout. It is shared in order to let developper change this layout options.

Implementation
    public function get biHierarchicalLayout():BiHierarchicalLayout
    public function set biHierarchicalLayout(value:BiHierarchicalLayout):void
buttonPlacementproperty 
buttonPlacement:String  [read-write]

Expand Collapse Button Placement. The possible values are :

    • midRight (GenericObject.BUTTON_AT_MID_RIGHT): button placed at the right of the node and Y centered
      midLeft (GenericObject.BUTTON_AT_MID_LEFT): button placed at the left of the node and Y centered
      midTop (GenericObject.BUTTON_AT_MID_TOP): button placed at the top of the node and X centered
      midBottom (GenericObject.BUTTON_AT_MID_BOTTOM): button placed at the bottom of the node and X centered
      topLeft (GenericObject.BUTTON_AT_TOP_LEFT): button placed at the top-left of the node
      topRight (GenericObject.BUTTON_AT_TOP_Right): button placed at the top-right of the node
      bottomleft (GenericObject.BUTTON_AT_BOTTOM_LEFT): button placed at the bottom-left of the nod
      bottomRight (GenericObject.BUTTON_AT_BOTTOM_RIGHT): button placed at the bottom-right of the node
  • Implementation
        public function get buttonPlacement():String
        public function set buttonPlacement(value:String):void

    See also

    com.kapit.visualizer.renderer.GenericOject
    circularLayoutproperty 
    circularLayout:SingleCycleCircularLayout  [read-write]

    Visualizer Circular Layout. It is shared in order to let developper change this layout options.

    Implementation
        public function get circularLayout():SingleCycleCircularLayout
        public function set circularLayout(value:SingleCycleCircularLayout):void
    clickLinkStyleproperty 
    clickLinkStyle:Object  [read-write]

    Link Style at Click. default {thickness: 7, color: 0xB4D5FC, alpha: 0.8}

    Implementation
        public function get clickLinkStyle():Object
        public function set clickLinkStyle(value:Object):void
    clickLinkStyleFunctionproperty 
    clickLinkStyleFunction:Function  [read-write]

    Link Style Function at Click that can be used to renderer links by consumin the source and target nodes data.

    Implementation
        public function get clickLinkStyleFunction():Function
        public function set clickLinkStyleFunction(value:Function):void
    clickNodeFiltersproperty 
    clickNodeFilters:Array  [read-write]

    Node Filters at Click.

    Implementation
        public function get clickNodeFilters():Array
        public function set clickNodeFilters(value:Array):void
    collapseButtonClassproperty 
    collapseButtonClass:Class  [read-write]

    Collapse Icon shown when the node is expanded.

    Implementation
        public function get collapseButtonClass():Class
        public function set collapseButtonClass(value:Class):void
    collapsedElementsMapproperty 
    protected var collapsedElementsMap:Dictionary
    collapseOverButtonClassproperty 
    collapseOverButtonClass:Class  [read-write]

    Collapse Icon shown when the node is expanded and the Expand/Collapse Button is rolled over.

    Implementation
        public function get collapseOverButtonClass():Class
        public function set collapseOverButtonClass(value:Class):void
    collpaseOverButtonClassproperty 
    collpaseOverButtonClass:Class  [read-write]Implementation
        public function get collpaseOverButtonClass():Class
        public function set collpaseOverButtonClass(value:Class):void
    colorFieldsproperty 
    colorFields:Array  [read-write]

    Colors for an analysisPath elements. It is ignored in case where the analysisPath isn't taken into account.

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

    Implementation
        public function get colorFields():Array
        public function set colorFields(value:Array):void
    coloringFunctionproperty 
    coloringFunction:Function  [read-write]

    Coloring function will set a given background color to any element by applying it. This function must return an short integer.

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

    Implementation
        public function get coloringFunction():Function
        public function set coloringFunction(value:Function):void
    coloringPolicyproperty 
    coloringPolicy:String  [read-write]

    Coloring policy used to designate layers elements or to differentiate GenericSprite elements.

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

    Implementation
        public function get coloringPolicy():String
        public function set coloringPolicy(value:String):void
    csvDelimiterproperty 
    csvDelimiter:String  [read-write]

    CSV delimiter.

    The default value is ;.

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

    Implementation
        public function get csvDelimiter():String
        public function set csvDelimiter(value:String):void
    customTreeDataDescriptorproperty 
    customTreeDataDescriptor:ITreeDataDescriptor  [read-write]

    Custom Tree Data descriptor for navigating inside data provider object.

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

    Implementation
        public function get customTreeDataDescriptor():ITreeDataDescriptor
        public function set customTreeDataDescriptor(value:ITreeDataDescriptor):void
    dataProviderproperty 
    dataProvider:Object  [read-write]

    Visualizer Data provider. It can be :

    defaultNodeHeightproperty 
    defaultNodeHeight:Number  [read-write]

    Default node height used when using custom multimediaClass.

    Implementation
        public function get defaultNodeHeight():Number
        public function set defaultNodeHeight(value:Number):void
    defaultNodeWidthproperty 
    defaultNodeWidth:Number  [read-write]

    Default node width used when using custom multimediaClass.

    Implementation
        public function get defaultNodeWidth():Number
        public function set defaultNodeWidth(value:Number):void
    enablePanproperty 
    enablePan:Boolean  [read-write]

    Indicator if panning the Visualizer content should be enabled.

    The default value is true.

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

    Implementation
        public function get enablePan():Boolean
        public function set enablePan(value:Boolean):void
    enableSelectionDragproperty 
    enableSelectionDrag:Boolean  [read-write]

    Indicator if selected elements can be dragged.

    The default value is true.

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

    Implementation
        public function get enableSelectionDrag():Boolean
        public function set enableSelectionDrag(value:Boolean):void
    enableZoomOnMouseWheelproperty 
    enableZoomOnMouseWheel:Boolean  [read-write]

    Indicator if the visualizer content should be zoomed on wheel event.

    The default value is true.

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

    Implementation
        public function get enableZoomOnMouseWheel():Boolean
        public function set enableZoomOnMouseWheel(value:Boolean):void
    expandButtonClassproperty 
    expandButtonClass:Class  [read-write]

    Expand Icon shown when the node is collapsed.

    Implementation
        public function get expandButtonClass():Class
        public function set expandButtonClass(value:Class):void
    expandOnDoubleClickproperty 
    expandOnDoubleClick:Boolean  [read-write]

    Indicator if elements with Expand (or Collapse) status should be collapsed (or expanded) by double click.

    The default value is false.

    Implementation
        public function get expandOnDoubleClick():Boolean
        public function set expandOnDoubleClick(value:Boolean):void
    expandOverButtonClassproperty 
    expandOverButtonClass:Class  [read-write]

    Expand Icon shown when the node is collapsed and the Expand/Collapse Button is rolled over.

    Implementation
        public function get expandOverButtonClass():Class
        public function set expandOverButtonClass(value:Class):void
    expandPolicyproperty 
    expandPolicy:uint  [read-write]

    Current Expand Policy used in the Visualizer. The allowed values are :

    • CENTER_GRAPH_ON_EXPAND : Centers the Graph on the Visualizer component after node expand.
      FIX_NODE_ON_EXPAND : Fixes nodes position after node expand.
      CENTER_NODE_ON_EXPAND : Centers expanded node on the Visualizer component center.
  • Implementation
        public function get expandPolicy():uint
        public function set expandPolicy(value:uint):void
  • firstColorproperty 
    firstColor:uint  [read-write]

    First extremity of the Bichromatic color sequence and used color for Monochromatic coloring.

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

    Implementation
        public function get firstColor():uint
        public function set firstColor(value:uint):void
    graphItemsproperty 
    graphItems:Dictionary  [read-only]

    Dictionary containing all graph elements (Links and Nodes). These elements are referenced using Keys that correpond to their IDs.

    Implementation
        public function get graphItems():Dictionary
    hideTooltipDelayproperty 
    hideTooltipDelay:Number  [read-write]

    Delay used for tooltip show.

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

    Implementation
        public function get hideTooltipDelay():Number
        public function set hideTooltipDelay(value:Number):void
    hierarchicalCyclicLayoutproperty 
    hierarchicalCyclicLayout:SugiyamaLayout  [read-write]

    Visualizer Hierarchical Cyclic Layout. It is shared in order to let developper change this layout options.

    Implementation
        public function get hierarchicalCyclicLayout():SugiyamaLayout
        public function set hierarchicalCyclicLayout(value:SugiyamaLayout):void
    hierarchicalTreeLayoutproperty 
    hierarchicalTreeLayout:HierarchicalLayout  [read-write]

    Visualizer Hierarchical Tree Layout. It is shared in order to let developper change this layout options.

    Implementation
        public function get hierarchicalTreeLayout():HierarchicalLayout
        public function set hierarchicalTreeLayout(value:HierarchicalLayout):void
    highlightLinkStyleproperty 
    highlightLinkStyle:Object  [read-write]

    Link Style at Roll Over. default {thickness: 7, color: 0x9381F9, alpha: 0.8}

    Implementation
        public function get highlightLinkStyle():Object
        public function set highlightLinkStyle(value:Object):void
    highlightLinkStyleFunctionproperty 
    highlightLinkStyleFunction:Function  [read-write]

    Link Style Function at Roll Over that can be used to renderer links by consumin the source and target nodes data.

    Implementation
        public function get highlightLinkStyleFunction():Function
        public function set highlightLinkStyleFunction(value:Function):void
    highlightNodeFiltersproperty 
    highlightNodeFilters:Array  [read-write]

    Node Filters at Roll Over.

    Implementation
        public function get highlightNodeFilters():Array
        public function set highlightNodeFilters(value:Array):void
    highlightPolicyproperty 
    highlightPolicy:uint  [read-write]

    Indicator for the Highlight policy that can be used. Two Highlight Policies are defined:

    Implementation
        public function get highlightPolicy():uint
        public function set highlightPolicy(value:uint):void
    idleLinkStyleproperty 
    idleLinkStyle:Object  [read-write]

    Link Style that can be used to renderer links. The supported link Style Object properties are : {ul} {li} Standard properties : pixelHinting(false),scaleMode("normal"),caps("none") and joints(null),miterLimit(3);{li} {li} thickeness : Link thickeness (1 by default);{li} {li} color: Link color (0x000000 by default);{li} {li} alpha: Link alpha (0.6 by default);{li} {li} renderingPolicy: Indicates if the rendering is dashed or not (values are 'solid' or 'dash', 'solid' value is used by default);{li} {li} dashed : Indicates if the rendering is dashed or not (

    The default value is {thickness:1, color:0x000000, alpha:0.6, pixelHinting:false, scaleMode:"normal", caps:"none", joints:null, miterLimit:3, dashed:false, onLength:5, offLength:5}.

    Implementation
        public function get idleLinkStyle():Object
        public function set idleLinkStyle(value:Object):void
    idleLinkStyleFunctionproperty 
    idleLinkStyleFunction:Function  [read-write]

    Link Style Function that can be used to renderer links by consumin the source and target nodes data.

    Implementation
        public function get idleLinkStyleFunction():Function
        public function set idleLinkStyleFunction(value:Function):void
    idleNodeFilersproperty 
    idleNodeFilers:Array  [read-write]

    Node Filters at Idle status.

    Implementation
        public function get idleNodeFilers():Array
        public function set idleNodeFilers(value:Array):void
    ignoreRootproperty 
    ignoreRoot:Boolean  [read-write]

    Indicator if common root node of ICollectionView should be ignored. This property should be used when manipulating ICollectionView instances or Object with children property or customTreeDataDescritor. Setting it to True, the generated output of the visualizer will be a disconnected graph showing the generated subGraphs from all direct input children.

    The default value is false.

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

    Implementation
        public function get ignoreRoot():Boolean
        public function set ignoreRoot(value:Boolean):void
    labelFieldFunctionproperty 
    labelFieldFunction:Function  [read-write]

    Label Function used to extract specific data in order to be displayed in each Sprite element.

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

    Implementation
        public function get labelFieldFunction():Function
        public function set labelFieldFunction(value:Function):void
    labelFieldsproperty 
    labelFields:Object  [read-write]

    Sprites label Fields. When data providers needs an analysisPath, each analysis Path element refers to a different type of GenericSprite with different styling, content and information. In this case, given its index, each Array in the labelFields will be used as schema to feed each sprite type with the appropriate text content. The length of labelFields should be equal to the analysisPath length. If not, the missed type will have no text content. In the case, where all sprites has the same logic type (example: all sprites referes to persons in an entreprise), the label Fields will be an array containing strings that defines the text content extraction schema for all sprites. The String representation of that Array is also handled (visualizer.labelFields=id;prop).

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

    Implementation
        public function get labelFields():Object
        public function set labelFields(value:Object):void

    Example
    Let's take a modified version of the CSV file already used (shown above), the chosen analysis Path is ["Entreprise", "Department", "EmployeeID"] and the delimiter should be ",". In this case, we have sprites that refers to entreprises, others to departments and Employees. We want to display for Entreprise-Sprites the list of departments and employees, for Department-Sprites the entreprise to which it belongs and for employees its ID and age. Thus, the labelFields should be [["Department","EmployeeID", ["Entreprise"], ["EmployeeID","Age"]].
       Entreprise,Department,EmployeeID,Age
       Enterp,D1,D11,21
       Enterp,D1,D12,52
       Enterp,D1,D13,23
       Enterp,D2,D21,26
       Enterp,D2,D22,59
       Enterp,D3,D31,32
       ...
       

    labelFontColorproperty 
    labelFontColor:uint  [read-write]

    Label Font color.

    Implementation
        public function get labelFontColor():uint
        public function set labelFontColor(value:uint):void
    labelFontFamilyproperty 
    labelFontFamily:String  [read-write]

    label font family.

    Implementation
        public function get labelFontFamily():String
        public function set labelFontFamily(value:String):void
    labelLinkFieldFunctionproperty 
    labelLinkFieldFunction:Function  [read-write]

    Label Function used to extract specific data in order to be displayed in each Link element.

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

    Implementation
        public function get labelLinkFieldFunction():Function
        public function set labelLinkFieldFunction(value:Function):void
    labelLinkFieldsproperty 
    labelLinkFields:Object  [read-write]

    Links label Fields.

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

    Implementation
        public function get labelLinkFields():Object
        public function set labelLinkFields(value:Object):void
    labelLinkFontColorproperty 
    labelLinkFontColor:uint  [read-write]

    Label Font color.

    Implementation
        public function get labelLinkFontColor():uint
        public function set labelLinkFontColor(value:uint):void
    labelLinkFontFamilyproperty 
    labelLinkFontFamily:String  [read-write]

    label link font family.

    Implementation
        public function get labelLinkFontFamily():String
        public function set labelLinkFontFamily(value:String):void
    labelLinkTitleFontColorproperty 
    labelLinkTitleFontColor:uint  [read-write]

    Label Font color.

    Implementation
        public function get labelLinkTitleFontColor():uint
        public function set labelLinkTitleFontColor(value:uint):void
    labelLinkTitlesproperty 
    labelLinkTitles:Object  [read-write]

    Titles to be displayed when using the DefaultItemRender. Array or String representation of that array are handled.

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

    Implementation
        public function get labelLinkTitles():Object
        public function set labelLinkTitles(value:Object):void
    labelTitleFontColorproperty 
    labelTitleFontColor:uint  [read-write]

    Label Font color.

    Implementation
        public function get labelTitleFontColor():uint
        public function set labelTitleFontColor(value:uint):void
    labelTitlesproperty 
    labelTitles:Object  [read-write]

    Titles to be displayed when using the DefaultItemRender. Array or String representation of that array are handled.

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

    Implementation
        public function get labelTitles():Object
        public function set labelTitles(value:Object):void
    layoutproperty 
    layout:Object  [read-write]

    Default visualizer layout Index. Provided layouts are:

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

    Implementation
        public function get layout():Object
        public function set layout(value:Object):void
    LayoutClassproperty 
    LayoutClass:Layout  [read-only]

    Current graph Layout class.

    Implementation
        public function get LayoutClass():Layout
    linkStyleproperty 
    linkStyle:Object  [read-write]

    Link Style used to draw links.

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

    Implementation
        public function get linkStyle():Object
        public function set linkStyle(value:Object):void
    maintainAspectRatioproperty 
    maintainAspectRatio:Boolean  [read-write]

    Maintain aspect ratio for Image Item Renderers.

    Implementation
        public function get maintainAspectRatio():Boolean
        public function set maintainAspectRatio(value:Boolean):void
    maxLevelproperty 
    maxLevel:uint  [read-only]

    Maximum level number of all hierarchies.

    Implementation
        public function get maxLevel():uint
    mergeDescriptorproperty 
    mergeDescriptor:MergeDescriptor  [read-write]

    This Class instance defines merging tasks that must be applied on a CSV source before displaying it. In fact, a MergeDescriptor instance is a set of MergeEntity instances, each one defines columns to be merged in one column according to a merging function. A MergeEntity instance is created by defining :

    A MergeEntity is a unit merging task that must be added to the MergeDescriptor to be taken into account using the addMergeDescription(mergeEntity) method. When merging, the developer can choose between leaving the content of merged columns to be taken into account when performing data processing and adding the merging column or replacing them by the resulting column. This can be accomplished by setting to true or false the leaveMergeColumns of the MergeDescriptor instance. The mergingDescriptor should be used only with CSV files.

    The default value is null.

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

    Implementation
        public function get mergeDescriptor():MergeDescriptor
        public function set mergeDescriptor(value:MergeDescriptor):void

    Example
    //Assuming a CSV that have two columns named "work_days" and "total_days" and that we want to merge them into // a "holidays" column via a substraction function named mergeFunction var mergeDescriptor:MergeDescriptor=new MergeDescriptor(); // Initializing a merge Descriptor var mergeEntity:MergeEntity=new MergeEntity(["work_days","total_days"],"holidays",mergeFunction); // Merging _"work_days"_ and _"total_days"_ into a _holidays_ column mergeDescriptor.addMergeDescription(mergeEntity); // Adding the merge entity to the merge descriptor mergeDescriptor.leaveMergeColumns=false; // Replace merged columns with new resulting column (_holidays_ column) myVisualizer.mergeDescriptor=mergeDescriptor; // Assigning Merging Descriptor ... private function mergeFunction(arr:Array):Number { if(arr.length!=2) return 0; return Number(arr[1])-Number(arr[0]); }

    mindMapLayoutproperty 
    mindMapLayout:MindMapLayout  [read-write]

    Visualizer Mind Map Layout suited for mind maps. It is shared in order to let developper change this layout options.

    Implementation
        public function get mindMapLayout():MindMapLayout
        public function set mindMapLayout(value:MindMapLayout):void
    mindMapOrientationFunctionproperty 
    public var mindMapOrientationFunction:Function

    Function specifying the orientation (right, left, top, bottom) for each node in the Visualizer Graph. This function has one argument which is the data of the GenericSprite

    multimediaClassproperty 
    multimediaClass:Class  [read-write]

    Image, Video or custom visual class that extends the DisplayObject class. This class, combined with the multimediaDataSource class will be used to feed each element with its content.

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

    Implementation
        public function get multimediaClass():Class
        public function set multimediaClass(value:Class):void
    multimediaDataSourceproperty 
    multimediaDataSource:Object  [read-write]

    multimediaDataSource specifies the data needed by the multimediaClass. It can be :

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

    Implementation
        public function get multimediaDataSource():Object
        public function set multimediaDataSource(value:Object):void

    Example
    The following usage of an XML file (converted to XMLListCollection) shows how to use the multimediaDataSource for ICollectionView instances.
       
       
       
       
       
       
       
       
       ...
       
       
       
    When using the above XML, The multimediaDataSource should be

    multimediaFunctionproperty 
    multimediaFunction:Function  [read-write]

    MultimediaData extraction Function used to extract specific multimedia (image, video...) in order to be displayed in each Sprite element.

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

    Implementation
        public function get multimediaFunction():Function
        public function set multimediaFunction(value:Function):void
    multimediaLinkClassproperty 
    multimediaLinkClass:Class  [read-write]

    Image, Video or custom visual class that extends the DisplayObject class. This class, combined with the multimediaLinkDataSource class will be used to feed each link with its content.

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

    Implementation
        public function get multimediaLinkClass():Class
        public function set multimediaLinkClass(value:Class):void
    multimediaLinkDataSourceproperty 
    multimediaLinkDataSource:Object  [read-write]

    multimediaLinkDataSource specifies the data needed by the multimediaLinkClass. It can be used only if Links have data.

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

    Implementation
        public function get multimediaLinkDataSource():Object
        public function set multimediaLinkDataSource(value:Object):void
    multimediaLinkFunctionproperty 
    multimediaLinkFunction:Function  [read-write]

    MultimediaLinkData extraction Function used to extract specific multimedia (image, video...) in order to be displayed in each link element.

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

    Implementation
        public function get multimediaLinkFunction():Function
        public function set multimediaLinkFunction(value:Function):void
    nodeZoomFactorproperty 
    nodeZoomFactor:Number  [read-write]

    Zoom Node Factor.

    Implementation
        public function get nodeZoomFactor():Number
        public function set nodeZoomFactor(value:Number):void
    normalizeNodesSizeproperty 
    normalizeNodesSize:Boolean  [read-write]

    Indicator if node sizes should be uniformized.

    The default value is true.

    Implementation
        public function get normalizeNodesSize():Boolean
        public function set normalizeNodesSize(value:Boolean):void
    orthogonalLayoutproperty 
    orthogonalLayout:OrthogonalLayout  [read-write]

    Visualizer Orthogonal Layout. It is shared in order to let developper change this layout options.

    Implementation
        public function get orthogonalLayout():OrthogonalLayout
        public function set orthogonalLayout(value:OrthogonalLayout):void
    radialLayoutproperty 
    radialLayout:RadialLayout  [read-write]

    Visualizer Radial Layout. It is shared in order to let developper change this layout options.

    Implementation
        public function get radialLayout():RadialLayout
        public function set radialLayout(value:RadialLayout):void
    ratioproperty 
    ratio:Number  [read-only]

    Current zoom ratio.

    Implementation
        public function get ratio():Number
    recordDelimiterproperty 
    recordDelimiter:String  [read-write]

    Record delimiter of CSV fields.

    The default value is null.

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

    Implementation
        public function get recordDelimiter():String
        public function set recordDelimiter(value:String):void
    reportingFunctionsproperty 
    reportingFunctions:Dictionary  [read-write]

    Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment. In fact, when building data sets and their corresponding data from a given column (or attribute), several rows are grouped into one row and each data field content (attribute column/attribute) is added to an array. Transforming the data fields arrays into a real data by applying standard or custom functions can be very important to have correct and coherent data for nodes data. The reportingFunctions property is a Dictionary that assigns to a given column key (column name for CSV) or attribute (for XML) its reporting function. This function should accept as parameters an array and a type class (uint for example). Actually, there are two standard functions that can be accessed statically from the ReportingUtils class:

    The default value is null.

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

    Implementation
        public function get reportingFunctions():Dictionary
        public function set reportingFunctions(value:Dictionary):void

    Example
    //Assuming a CSV that have six columns ( "Entreprise", "Name", "Departement", "Technology", "Name", "Holidays") //and that we have specified ["Entreprise", "Name", "Departement"] as an analysisPath, we want to specify to sum Holidays Data sets for each generated node data and to compute Age mean for ech department, technology and Employee. The following snippet shows how reporting functions solves the problem. var reportingFunctions:Dictionary=new Dictionary(); reportingFunctions["Age"]=ReportingUtils.mean; reportingFunctions["Holidays"]=ReportingUtils.sum; myVisualizer.reportingFunctions=reportingFunctions;

    secondColorproperty 
    secondColor:uint  [read-write]

    Second extremity of the Bichromatic color sequence.

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

    Implementation
        public function get secondColor():uint
        public function set secondColor(value:uint):void
    showExpandCollapseButtonproperty 
    showExpandCollapseButton:Boolean  [read-write]

    Indicator if default Expand/Collapse Buttons should be disabled.

    The default value is true.

    Implementation
        public function get showExpandCollapseButton():Boolean
        public function set showExpandCollapseButton(value:Boolean):void
    showLinkLabelsAtClickproperty 
    showLinkLabelsAtClick:Boolean  [read-write]

    Indicator if Link Decorators should be shown only on a clicked item links.

    The default value is false.

    Implementation
        public function get showLinkLabelsAtClick():Boolean
        public function set showLinkLabelsAtClick(value:Boolean):void
    staticOrganicLayoutproperty 
    staticOrganicLayout:StaticGEMLayout  [read-write]

    Visualizer Organic Layout. It is shared in order to let developper change this layout options.

    Implementation
        public function get staticOrganicLayout():StaticGEMLayout
        public function set staticOrganicLayout(value:StaticGEMLayout):void
    statusproperty 
    status:uint  [read-only]

    Indicates Visualizer status. Viewer status can be:

    Implementation
        public function get status():uint
    toolTipFieldFunctionproperty 
    toolTipFieldFunction:Function  [read-write]

    Tooltip Function used to extract specific data in order to be displayed in each Sprite element.

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

    Implementation
        public function get toolTipFieldFunction():Function
        public function set toolTipFieldFunction(value:Function):void
    tooltipFieldsproperty 
    tooltipFields:Object  [read-write]

    Sprites tooltip Fields. When data providers needs an analysisPath, each analysis Path element refers to a different type of GenericSprite with different styling, content and information. In this case, given its index, each Array in the tooltipFields will be used as schema to feed each sprite type tooltip with the appropriate content. The length of tooltipFields should be equal to the labelFields and analysisPath length. If not, the missed type will have no tooltip. In the case, where all sprites has the same logic type (example: all sprites referes to persons in an entreprise), the tooltip Fields will be an array containing strings that defines the content extraction schema for all sprites.The String representation of that Array is also handled (visualizer.tooltipFields=id;prop) The same example shown for the labelFields can be applied for tooltipFields.

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

    Implementation
        public function get tooltipFields():Object
        public function set tooltipFields(value:Object):void

    See also

    labelFields
    tooltipFontColorproperty 
    tooltipFontColor:uint  [read-write]

    Tootltip font color.

    Implementation
        public function get tooltipFontColor():uint
        public function set tooltipFontColor(value:uint):void
    tooltipFontFamilyproperty 
    tooltipFontFamily:String  [read-write]

    Tootltip font family.

    Implementation
        public function get tooltipFontFamily():String
        public function set tooltipFontFamily(value:String):void
    toolTipLinkFieldFunctionproperty 
    toolTipLinkFieldFunction:Function  [read-write]

    Tooltip Function used to extract specific data in order to be displayed in each Link element.

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

    Implementation
        public function get toolTipLinkFieldFunction():Function
        public function set toolTipLinkFieldFunction(value:Function):void
    tooltipLinkFieldsproperty 
    tooltipLinkFields:Object  [read-write]

    Links tooltip Fields.

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

    Implementation
        public function get tooltipLinkFields():Object
        public function set tooltipLinkFields(value:Object):void
    tooltipLinkFontColorproperty 
    tooltipLinkFontColor:uint  [read-write]

    Tooltip Link Font color.

    Implementation
        public function get tooltipLinkFontColor():uint
        public function set tooltipLinkFontColor(value:uint):void
    tooltipLinkRendererFunctionproperty 
    tooltipLinkRendererFunction:Function  [read-write]

    Tooltip Function used define a custom tooltip renderer for link.

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

    Implementation
        public function get tooltipLinkRendererFunction():Function
        public function set tooltipLinkRendererFunction(value:Function):void
    tooltipLinkTitleFontColorproperty 
    tooltipLinkTitleFontColor:uint  [read-write]

    Tooltip Title Link Font color.

    Implementation
        public function get tooltipLinkTitleFontColor():uint
        public function set tooltipLinkTitleFontColor(value:uint):void
    toolTipLinkTitlesproperty 
    toolTipLinkTitles:Object  [read-write]

    ToolTips to be activated when using the DefaultItemRenderer. Array or String representation of that Array are handled.

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

    Implementation
        public function get toolTipLinkTitles():Object
        public function set toolTipLinkTitles(value:Object):void
    tooltipRendererFunctionproperty 
    tooltipRendererFunction:Function  [read-write]

    Tooltip Function used define a custom tooltip renderer for sprite node.

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

    Implementation
        public function get tooltipRendererFunction():Function
        public function set tooltipRendererFunction(value:Function):void
    tooltipTitleFontColorproperty 
    tooltipTitleFontColor:uint  [read-write]

    Tootltip Title font color.

    Implementation
        public function get tooltipTitleFontColor():uint
        public function set tooltipTitleFontColor(value:uint):void
    toolTipTitlesproperty 
    toolTipTitles:Object  [read-write]

    ToolTips to be activated when using the DefaultItemRender. Array or String representation of that Array are handled.

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

    Implementation
        public function get toolTipTitles():Object
        public function set toolTipTitles(value:Object):void
    typesDescriptorproperty 
    typesDescriptor:Dictionary  [read-write]

    Column types descriptor. This Object specifies the Class needed to parse the content of a column fields. By default, the Visualizer component recognize Data Types of columns content (String, Number, Date....). But in some cases, especially when dealing with IDs, Numbers, for example, must be considered as String and we need to specify this for the Visualizer. The solution is to specify the Type of the column fields where bypassing the automatic type assignment is needed. The Types Descripor is a Dictionary that allows to assign a Type Class to a given column data and thus giving the Visualizer integrator the possibility to correctly describe the content of his data source columns.

    The default value is null;.

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

    Implementation
        public function get typesDescriptor():Dictionary
        public function set typesDescriptor(value:Dictionary):void

    Example
    var typesDescriptor:Dictionary= new Dictionary(); typesDescriptor["Age"]=String; typesDescriptor["BirthDay"]=Date; myVisualizer.typesDescriptor=typesDescriptor;

    UIDproperty 
    UID:String  [read-only]

    Component UID.

    Implementation
        public function get UID():String
    uniformColorproperty 
    uniformColor:uint  [read-write]

    Default color used with Default item renderer.

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

    Implementation
        public function get uniformColor():uint
        public function set uniformColor(value:uint):void
    useMultiLinkproperty 
    useMultiLink:Boolean  [read-write]Implementation
        public function get useMultiLink():Boolean
        public function set useMultiLink(value:Boolean):void
    visibilityLevelproperty 
    visibilityLevel:int  [read-write]

    Visiblity Level of the generated graph. Using Expand/Collapse Functionalities, the graph can be generated at a given level of visibility. This functionality is provided only for IHierarchicalData and ArrayCollection data providers and is suited for huge hiearchies.

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

    Implementation
        public function get visibilityLevel():int
        public function set visibilityLevel(value:int):void
    withHeadersproperty 
    withHeaders:Boolean  [read-write]

    Indicator if CSV file first row are headers or not.

    The default value is true.

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

    Implementation
        public function get withHeaders():Boolean
        public function set withHeaders(value:Boolean):void
    zoomNodeNodeOnRollOverproperty 
    zoomNodeNodeOnRollOver:Boolean  [write-only]Implementation
        public function set zoomNodeNodeOnRollOver(value:Boolean):void
    zoomNodeOnRollOverproperty 
    zoomNodeOnRollOver:Boolean  [read-only]

    Zoom Node on Roll Over.

    Implementation
        public function get zoomNodeOnRollOver():Boolean
    Constructor detail
    Visualizer()constructor
    public function Visualizer()

    Constructor.

    Method detail
    addLinkElement()method
    public function addLinkElement(data:Object, sourceObject:GenericObject, targetObject:GenericObject, uid:String = null, linkStyle:Object = null, isGML:Boolean = false, updateStructure:Boolean = false):GenericLink

    Add link to the graph.

    Parameters
    data:Object — Link data.
     
    sourceObject:GenericObject — Source Object.
     
    targetObject:GenericObject — Target Object
     
    uid:String (default = null) — Id
     
    linkStyle:Object (default = null) — Link style to be applied on the link to be created.
     
    isGML:Boolean (default = false)
     
    updateStructure:Boolean (default = false)

    Returns
    GenericLink — Created link.
    addNodeElement()method 
    public function addNodeElement(data:Object, parentExpandSprite:GenericSprite = null, position:Point = null, uid:String = null, isGML:Boolean = false, updateStructure:Boolean = false):GenericSprite

    Add a Node to the Graph with respect to Expand/Collapse policy

    Parameters
    data:Object — Data of the node
     
    parentExpandSprite:GenericSprite (default = null) — Expand/Collapse parent
     
    position:Point (default = null) — Node position at creation
     
    uid:String (default = null) — ID
     
    isGML:Boolean (default = false)
     
    updateStructure:Boolean (default = false)

    Returns
    GenericSprite — Created Generic Sprite.
    autoFit()method 
    public function autoFit(withAnimation:Boolean = true, duration:uint = 1000, horizontalGap:Number = 30, verticalGap:Number = 30, layoutDependant:Boolean = false, ratioNotLessThanOne:Boolean = true):void

    Fits the Visualizer content to the visible region.

    Parameters
    withAnimation:Boolean (default = true) — Indicator if the autofit task should be animated or not. If True, a zoom/move animation will be performed.
     
    duration:uint (default = 1000) — Autofit animation duration.
     
    horizontalGap:Number (default = 30) — True if the autofit animation depends from a layout action.
     
    verticalGap:Number (default = 30)
     
    layoutDependant:Boolean (default = false)
     
    ratioNotLessThanOne:Boolean (default = true)
    centerContent()method 
    public function centerContent(withAnimation:Boolean = true):void

    Centers the content of the visualizer.

    Parameters
    withAnimation:Boolean (default = true) — Indicator if the centering task should be animated or not. If true, a move animation will be performed.
    centerNode()method 
    public function centerNode(sprite:GenericSprite):void

    enters a given Node on the Visualizer component center.

    Parameters
    sprite:GenericSprite — Node to be centered.
    centerNodes()method 
    public function centerNodes(sprites:Array):void

    enters a set of Nodes on the Visualizer component center.

    Parameters
    sprites:Array — Nodes to be centered.
    commitProperties()method 
    protected override function commitProperties():void

    inheritDoc

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

    getBitmapData()method 
    public function getBitmapData(width:Number, height:Number):BitmapDataParameters
    width:Number
     
    height:Number

    Returns
    BitmapData
    handleResize()method 
    protected function handleResize(event:ResizeEvent):voidParameters
    event:ResizeEvent
    invalidateLinksStyle()method 
    public function invalidateLinksStyle():void

    Reloads Link Style according to the Style Objects content and forces links redraw.

    invalidateNodesStyle()method 
    public function invalidateNodesStyle():void

    Reloads Node Style according to the Style Objects content and forces Nodes filters re-application.

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

    panContentBy()method 
    public function panContentBy(deltaX:Number, deltaY:Number, ratio:Number = 1, withAnimation:Boolean = false):void

    Move the content of the Visualizer by deltaX in the XAxis and deltaY in the YAxis while applying a zoom effect given the ratio.

    Parameters
    deltaX:Number — X axis move.
     
    deltaY:Number — Y axis move.
     
    ratio:Number (default = 1) — Zoom ratio.
     
    withAnimation:Boolean (default = false) — Indicates if animation should be enabled.
    panContentTo()method 
    public function panContentTo(point:Point, startPoint:Point = null, ratio:Number = 1, withAnimation:Boolean = false):void

    Pans the content of the Visualizer to a new Position from a StartPoint (Control Point).

    Parameters
    point:Point — Destination Point.
     
    startPoint:Point (default = null) — Start Point. This value is by default set to the center of the Visualizer.
     
    ratio:Number (default = 1)
     
    withAnimation:Boolean (default = false)
    reLayout()method 
    public function reLayout(fixedElement:GenericSprite = null):void

    Performs another layout computation. It is advised to be used when the graph configuration have been changed due to user interaction.

    Parameters
    fixedElement:GenericSprite (default = null) — Element which should be fixed on relayout
    removeAll()method 
    public override function removeAll():void

    Remove all Items of the Graph in the Visualizer.

    removeLinkElement()method 
    public function removeLinkElement(uid:String = null, noEvent:Boolean = false):void

    Remove a Link element from the Graph given its unique ID.

    Parameters
    uid:String (default = null) — Unique ID of the GenericLink.
     
    noEvent:Boolean (default = false) — Indicates if no event should be dispatched.
    removeLinkElementInstance()method 
    public function removeLinkElementInstance(link:GenericLink, noEvent:Boolean = false):void

    Remove a Link element from the Graph given its unique ID.

    Parameters
    link:GenericLink — GenericLink instance.
     
    noEvent:Boolean (default = false) — Indicates if no event should be dispatched.
    removeNodeElement()method 
    public function removeNodeElement(uid:String = null, removeChildren:Boolean = true, noEvent:Boolean = true):void

    Remove Node from the Visualizer given its unique id.

    Parameters
    uid:String (default = null) — Id of the node to be deleted.
     
    removeChildren:Boolean (default = true) — Remove node children.
     
    noEvent:Boolean (default = true) — Indicates if no event should be dispatched.
    searchElement()method 
    public function searchElement(searchKey:String, filters:Array = null, property:String = null, byID:Boolean = false, centerResult:Boolean = true, expand:Boolean = true):Array

    Search for Elements given a search key and property and apply a filter on the found ones.

    Parameters
    searchKey:String — Search key.
     
    filters:Array (default = null) — Element Filters.
     
    property:String (default = null) — Property that must be considered when searching.
     
    byID:Boolean (default = false) — Indicates if the search should be only applied on items IDs (For CSV data input).
     
    centerResult:Boolean (default = true) — Centers found entities after search.
     
    expand:Boolean (default = true) — Expands Hidden nodes if included in the current search Result. Setting this argument to true, forces ignoring recentring as a Relayout is needed.

    Returns
    Array
    synchronizeContent()method 
    public function synchronizeContent():void
    updateInternalStructure()method 
    public function updateInternalStructure():void

    Updates SubGraphs and Hierarchies computation. Should be used in cases where the graph is generated using AddNodeElement and AddLinkElement.

    updateLinksStyle()method 
    public function updateLinksStyle():void

    Refreshe All Links Style and Link Decorators.

    updateLinkStyle()method 
    public function updateLinkStyle(link:GenericLink):void

    Refresh a Link Style and Link Decorator.

    Parameters
    link:GenericLink — Link to be updated.
    updateNodesExpandCollapseButton()method 
    public function updateNodesExpandCollapseButton():void

    Shows or hides Nodes Expand/Collapse Button.

    updateNodesSize()method 
    public function updateNodesSize():void

    Updates Node size according to NormalizeNodesSize property.

    updateNodesStyle()method 
    public function updateNodesStyle():void

    Invalidates Nodes Styles and updates filters and visual properties of the Visualizer.

    zoomContent()method 
    public function zoomContent(ratio:Number, zoomPosition:Point = null, relativeZoom:Boolean = true, withAnimation:Boolean = true, duration:uint = 1000):void

    Performs a zoom on the Visualizer given a zoom ratio and its relativity.

    Parameters
    ratio:Number — Zoom ratio.
     
    zoomPosition:Point (default = null) — Zoom focus point.
     
    relativeZoom:Boolean (default = true) — Indicator if the specified ratio must be applied relatively to the current zoom ratio or not.
     
    withAnimation:Boolean (default = true) — Indicator if the autofit task should be animated or not. If True, a zoom/move animation will be performed.
     
    duration:uint (default = 1000) — Autofit animation duration.
    Event detail
    animationStoppedevent 
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the Visualizer content animation has ended.

    dataLoadedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the Visualizer data input has been loaded and rendered.

    elementClickedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that an element has been clicked.

    elementCollapsedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that an element has been Collapsed.

    elementDoubleClickedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that an element has been double clicked.

    elementExpandedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that an element has been Expanded.

    elementRollOutevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that an element is being rolled out.

    elementRollOverevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that an element is being rolled over.

    elementsDragFinishedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the user stopped dragging elements.

    elementsDragStartedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the user starts dragging an element.

    elementsStatusChangedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates All elements which Expand/Collapse Status have been changed.

    scrollBeginevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the user has started scrolling inside the visualizer

    scrollEndevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the user has ended a scrolling operation inside the visualizer.

    visibilityLevelChangedevent  
    Event object type: com.kapit.visualizer.events.VisualizerEvent

    Indicates that the visibility level has been changed. The event contains first level GenericSprite elements that have been collapsed or expanded.

    Constant detail
    ANIMATING_STATUSconstant
    public static const ANIMATING_STATUS:uint = 1

    ANIMATING Visualizer status. Visualizer is performing an animation task.

    BALLOON_LAYOUTconstant 
    public static const BALLOON_LAYOUT:uint = 3

    Balloon Layout Index.

    BICHROMATIC_COLORINGconstant 
    public static const BICHROMATIC_COLORING:String = "bichromatic"

    Bichromatic coloring policy.

    BIHIERARCHICAL_LAYOUTconstant 
    public static const BIHIERARCHICAL_LAYOUT:uint = 9

    BiHierarchical Layout Index

    BUSY_STATUSconstant 
    public static const BUSY_STATUS:uint = 4

    BUSY Visualizer status. Visualizer is performing a layout computation task.

    CENTER_GRAPH_ON_EXPANDconstant 
    public static const CENTER_GRAPH_ON_EXPAND:uint = 0

    Expand Policy indicating that the graph should be centered after Expand.

    CENTER_NODE_ON_EXPANDconstant 
    public static const CENTER_NODE_ON_EXPAND:uint = 2

    Expand Policy indicating that the expanded node should be centered after expand.

    CIRCULAR_BASED_HIGHLIGHTconstant 
    public static const CIRCULAR_BASED_HIGHLIGHT:uint = 0

    Circular Highlight Policy constant.

    CIRCULAR_LAYOUTconstant 
    public static const CIRCULAR_LAYOUT:uint = 0

    Circular Layout Index.

    DEFAULT_COLORconstant 
    public static const DEFAULT_COLOR:uint = 0xCEB8AE

    Default color used on Uniform coloring mode (used with DefaultItemRenderer).

    DEFAULT_FIRST_COLORconstant 
    public static const DEFAULT_FIRST_COLOR:uint = 0x145363

    Default First color extremity used on Bichromatic coloring mode (used with DefaultItemRenderer and Hierarchical data structure).

    DEFAULT_NODE_HEIGHTconstant 
    public static const DEFAULT_NODE_HEIGHT:Number = 20

    Default Item Height.

    DEFAULT_NODE_WIDTHconstant 
    public static const DEFAULT_NODE_WIDTH:Number = 20

    Default Item Width.

    DEFAULT_NODE_ZOOM_FACTORconstant 
    public static const DEFAULT_NODE_ZOOM_FACTOR:Number = 1.4

    Default Node Zoom at Highlight

    DEFAULT_SECOND_COLORconstant 
    public static const DEFAULT_SECOND_COLOR:uint = 0xC9C5FC

    Default Last color extremity used on Bichromatic coloring mode (used with DefaultItemRenderer and Hierarchical data structure).

    FILTER_BASED_HIGHLIGHTconstant 
    public static const FILTER_BASED_HIGHLIGHT:uint = 1

    Filter based Highlight Policy constant.

    FIX_NODE_ON_EXPANDconstant 
    public static const FIX_NODE_ON_EXPAND:uint = 1

    Expand Policy indicating that the expanded node should be fixed after expand.

    HIERARCHICAL_CYCLIC_LAYOUTconstant 
    public static const HIERARCHICAL_CYCLIC_LAYOUT:uint = 4

    Sugiyama Layout Index.

    HIERARCHICAL_TREE_LAYOUTconstant 
    public static const HIERARCHICAL_TREE_LAYOUT:uint = 1

    Hierarchical Layout Index.

    IDLE_STATUSconstant 
    public static const IDLE_STATUS:uint = 0

    IDLE Visualizer status. Visualizer is not performing any operation.

    MINDMAP_LAYOUTconstant 
    public static const MINDMAP_LAYOUT:uint = 8

    MindMap Layout Index.

    MONOCHROMATIC_COLORINGconstant 
    public static const MONOCHROMATIC_COLORING:String = "monochromatic"

    Monochromatic coloring policy.

    ORTHOGONAL_LAYOUTconstant 
    public static const ORTHOGONAL_LAYOUT:uint = 7

    Orthogonal Layout Index.

    PAN_STATUSconstant 
    public static const PAN_STATUS:uint = 2

    Pan Visualizer status. Visualizer is performing a Pan task.

    RADIAL_LAYOUTconstant 
    public static const RADIAL_LAYOUT:uint = 2

    Radial Layout Index.

    SELECTION_MOVE_STATUSconstant 
    public static const SELECTION_MOVE_STATUS:uint = 3

    Selection Move Visualizer status. Visualizer is moving the selection.

    STATIC_ORGANIC_LAYOUTconstant 
    public static const STATIC_ORGANIC_LAYOUT:uint = 5

    GEM Layout Index.

    UNIFORM_COLORINGconstant 
    public static const UNIFORM_COLORING:String = "none"

    Uniform coloring policy.