Home > Class Reference > ENSLIB namespace > %ZEN.SVGComponent.radialNavigator

%ZEN.SVGComponent.radialNavigator

class %ZEN.SVGComponent.radialNavigator extends %ZEN.SVGComponent.svgComponent

This is a specialized SVG component that displays the relationship between a set of data items as a radial diagram.
The data is displayed as a central circular hub surrounded by a set of evenly spaced nodes. The number and contents of the nodes is specified by an array of %ZEN.Auxiliary.radialNode objects.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTVIEWBOXHEIGHT = 100;
Default viewBoxHeight of this component. This is set to 100 to provide a fixed coordinate system.
parameter DEFAULTVIEWBOXWIDTH = 100;
Default viewBoxWidth of this component. This is set to 100 to provide a fixed coordinate system.

Properties (Including Private)

property backgroundStyle as %ZEN.Datatype.svgStyle;
Optional: style used for background panel.
Property methods: backgroundStyleDisplayToLogical(), backgroundStyleGet(), backgroundStyleIsValid(), backgroundStyleLogicalToDisplay(), backgroundStyleLogicalToOdbc(), backgroundStyleNormalize(), backgroundStyleSet()
property hubStyle as %ZEN.Datatype.svgStyle;
Optional: style applied to central hub.
Property methods: hubStyleDisplayToLogical(), hubStyleGet(), hubStyleIsValid(), hubStyleLogicalToDisplay(), hubStyleLogicalToOdbc(), hubStyleNormalize(), hubStyleSet()
property mainLabel as %ZEN.Datatype.caption;
Label for central hub.
Property methods: mainLabelDisplayToLogical(), mainLabelGet(), mainLabelIsValid(), mainLabelLogicalToDisplay(), mainLabelLogicalToOdbc(), mainLabelNormalize(), mainLabelSet(), mainLabelStyleDisplayToLogical(), mainLabelStyleGet(), mainLabelStyleIsValid(), mainLabelStyleLogicalToDisplay(), mainLabelStyleLogicalToOdbc(), mainLabelStyleNormalize(), mainLabelStyleSet()
property mainLabelStyle as %ZEN.Datatype.svgStyle;
Optional: style used for main hub label text.
Property methods: mainLabelStyleDisplayToLogical(), mainLabelStyleGet(), mainLabelStyleIsValid(), mainLabelStyleLogicalToDisplay(), mainLabelStyleLogicalToOdbc(), mainLabelStyleNormalize(), mainLabelStyleSet()
property nodeStyle as %ZEN.Datatype.svgStyle;
Optional: style applied to nodes.
Property methods: nodeStyleDisplayToLogical(), nodeStyleGet(), nodeStyleIsValid(), nodeStyleLogicalToDisplay(), nodeStyleLogicalToOdbc(), nodeStyleNormalize(), nodeStyleSet()
property nodes as list of %ZEN.Auxiliary.radialNode (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE");
List of node information objects. Each object specifies details about a node displayed by the Navigator.
Property methods: nodesBuildValueArray(), nodesCollectionToDisplay(), nodesCollectionToOdbc(), nodesDisplayToCollection(), nodesGet(), nodesGetObject(), nodesGetObjectId(), nodesGetSwizzled(), nodesIsValid(), nodesOdbcToCollection(), nodesSet(), nodesSetObject(), nodesSetObjectId()
property onselectNode as %ZEN.Datatype.eventHandler;
onselectNode event handler: This event is fired when the mouse is clicked on a Node.
When this event is invoked, the selectedIndex will contain the index (0-based) of the current node. If the user clicks on the central node then selectedIndex will be -1;
Property methods: onselectNodeDisplayToLogical(), onselectNodeGet(), onselectNodeIsValid(), onselectNodeLogicalToDisplay(), onselectNodeLogicalToOdbc(), onselectNodeNormalize(), onselectNodeSet()
property scaleNodes as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Optional: if true, then scale the size of the outer nodes proportionally to their value.
Property methods: scaleNodesDisplayToLogical(), scaleNodesGet(), scaleNodesIsValid(), scaleNodesLogicalToDisplay(), scaleNodesLogicalToOdbc(), scaleNodesLogicalToXSD(), scaleNodesNormalize(), scaleNodesSet(), scaleNodesXSDToLogical()
property selectedIndex as %ZEN.Datatype.integer [ InitialExpression = -2 ];
Index (0-based) of selected node. -1 means that the central node is selected. -2 means that no node is selected.
Property methods: selectedIndexDisplayToLogical(), selectedIndexGet(), selectedIndexIsValid(), selectedIndexLogicalToDisplay(), selectedIndexLogicalToOdbc(), selectedIndexNormalize(), selectedIndexSet()
property title as %ZEN.Datatype.caption;
Title displayed by navigator.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet(), titleStyleDisplayToLogical(), titleStyleGet(), titleStyleIsValid(), titleStyleLogicalToDisplay(), titleStyleLogicalToOdbc(), titleStyleNormalize(), titleStyleSet()
property titleStyle as %ZEN.Datatype.svgStyle;
Optional: style used for title text.
Property methods: titleStyleDisplayToLogical(), titleStyleGet(), titleStyleIsValid(), titleStyleLogicalToDisplay(), titleStyleLogicalToOdbc(), titleStyleNormalize(), titleStyleSet()

Methods (Including Private)

clientmethod appendNode(node) [ Language = javascript ]
Append a new node object to this navigator.
The node object should be created by calling:
node = zenPage.createComponent('radialNode');
clientmethod clearNodes() [ Language = javascript ]
Remove the set of nodes associated with this Navigator.
clientmethod drawConnector(group, angle) [ Language = javascript ]
Draw a connector.
clientmethod drawNode(group, type, angle, node, num, size) [ Language = javascript ]
Draw a node.
clientmethod getCurrNode() [ Language = javascript ]
Return the current selected node object associated with this Navigator.
clientmethod getNode(index) [ Language = javascript ]
Return a node object associated with this Navigator given its index number (0-based).
clientmethod nodeClickHandler(evt, type, nodeIndex) [ Language = javascript ]
Onclick handler for nodes.
clientmethod nodeMouseHandler(evt, flag, nodeIndex) [ Language = javascript ]