Packagecom.asterisq.constellation
Interfacepublic interface IConstellation extends flash.events.IEventDispatcher
ImplementorsConstellation

The interface for the Constellation graph visualization component.



Public Properties
 PropertyDefined by
  behaviors : Array
An ordered list of behaviors which affect nodes in the visualization.
IConstellation
  center : Point
[read-only] The center point of the Constellation component.
IConstellation
  dataProvider : IGraph
The graph data provider.
IConstellation
  edgeRendererFactory : IEdgeRendererFactory
The factory instance used to instantiate edge renderers.
IConstellation
  edgeRenderers : Array
[read-only] A list of all edge renderers.
IConstellation
  nodeRendererFactory : INodeRendererFactory
The factory instance used to instantiate node renderers.
IConstellation
  nodeRenderers : Array
[read-only] A list of all node renderers.
IConstellation
  paused : Boolean
Indicates whether the visualization physics is paused.
IConstellation
  stepDuration : Number
The number of milliseconds between steps in the physics engine.
IConstellation
Public Methods
 MethodDefined by
  
Fetches the edge renderer with the given ID.
IConstellation
  
getEdgeRendererByNodeIDs(tailNodeID:String, headNodeID:String, bidirectional:Boolean):IEdgeRenderer
Fetches the an edge renderer with the given tail and head node IDs.
IConstellation
  
getEdgeRenderersByDataProperty(propertyName:String, propertyValue:*):Array
Fetches all edge renderers that match the given property name and value.
IConstellation
  
Fetches the node renderer with the given ID.
IConstellation
  
getNodeRenderersByDataProperty(propertyName:String, propertyValue:*):Array
Fetches all node renderers that match the given property name and value.
IConstellation
Property detail
behaviorsproperty
behaviors:Array  [read-write]

An ordered list of behaviors which affect nodes in the visualization.

Implementation
    public function get behaviors():Array
    public function set behaviors(value:Array):void
centerproperty 
center:Point  [read-only]

The center point of the Constellation component.

Implementation
    public function get center():Point
dataProviderproperty 
dataProvider:IGraph  [read-write]

The graph data provider. Nodes and edges in this graph are displayed in the graph visualization

Implementation
    public function get dataProvider():IGraph
    public function set dataProvider(value:IGraph):void
edgeRendererFactoryproperty 
edgeRendererFactory:IEdgeRendererFactory  [read-write]

The factory instance used to instantiate edge renderers.

Implementation
    public function get edgeRendererFactory():IEdgeRendererFactory
    public function set edgeRendererFactory(value:IEdgeRendererFactory):void
edgeRenderersproperty 
edgeRenderers:Array  [read-only]

A list of all edge renderers.

Implementation
    public function get edgeRenderers():Array
nodeRendererFactoryproperty 
nodeRendererFactory:INodeRendererFactory  [read-write]

The factory instance used to instantiate node renderers.

Implementation
    public function get nodeRendererFactory():INodeRendererFactory
    public function set nodeRendererFactory(value:INodeRendererFactory):void
nodeRenderersproperty 
nodeRenderers:Array  [read-only]

A list of all node renderers.

Implementation
    public function get nodeRenderers():Array
pausedproperty 
paused:Boolean  [read-write]

Indicates whether the visualization physics is paused.

Implementation
    public function get paused():Boolean
    public function set paused(value:Boolean):void
stepDurationproperty 
stepDuration:Number  [read-write]

The number of milliseconds between steps in the physics engine. The default value is 30 ms.

Implementation
    public function get stepDuration():Number
    public function set stepDuration(value:Number):void
Method detail
getEdgeRendererByID()method
public function getEdgeRendererByID(edgeID:String):IEdgeRenderer

Fetches the edge renderer with the given ID.

Parameters
edgeID:String

Returns
IEdgeRenderer
getEdgeRendererByNodeIDs()method 
public function getEdgeRendererByNodeIDs(tailNodeID:String, headNodeID:String, bidirectional:Boolean):IEdgeRenderer

Fetches the an edge renderer with the given tail and head node IDs. Note that there may be more than one but this function only returns the first one found. The bidirectional parameter should be set to true if the directionality between the nodes isn't important.

Parameters
tailNodeID:String
 
headNodeID:String
 
bidirectional:Boolean

Returns
IEdgeRenderer
getEdgeRenderersByDataProperty()method 
public function getEdgeRenderersByDataProperty(propertyName:String, propertyValue:*):Array

Fetches all edge renderers that match the given property name and value.

Parameters
propertyName:String
 
propertyValue:*

Returns
Array
getNodeRendererByID()method 
public function getNodeRendererByID(nodeID:String):INodeRenderer

Fetches the node renderer with the given ID.

Parameters
nodeID:String

Returns
INodeRenderer
getNodeRenderersByDataProperty()method 
public function getNodeRenderersByDataProperty(propertyName:String, propertyValue:*):Array

Fetches all node renderers that match the given property name and value.

Parameters
propertyName:String
 
propertyValue:*

Returns
Array