Skip to main content

%ZEN.SVGComponent.radialNavigator

Class %ZEN.SVGComponent.radialNavigator Extends svgComponent [ Deprecated, System = 3 ]

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.

Parameters

DEFAULTVIEWBOXWIDTH

Parameter DEFAULTVIEWBOXWIDTH As INTEGER = 100;

Default viewBoxWidth of this component. This is set to 100 to provide a fixed coordinate system.

DEFAULTVIEWBOXHEIGHT

Parameter DEFAULTVIEWBOXHEIGHT As INTEGER = 100;

Default viewBoxHeight of this component. This is set to 100 to provide a fixed coordinate system.

Properties

nodes

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.

title

Property title As %ZEN.Datatype.caption;

Title displayed by navigator.

mainLabel

Property mainLabel As %ZEN.Datatype.caption;

Label for central hub.

backgroundStyle

Property backgroundStyle As %ZEN.Datatype.svgStyle;

Optional: style used for background panel.

titleStyle

Property titleStyle As %ZEN.Datatype.svgStyle;

Optional: style used for title text.

mainLabelStyle

Property mainLabelStyle As %ZEN.Datatype.svgStyle;

Optional: style used for main hub label text.

hubStyle

Property hubStyle As %ZEN.Datatype.svgStyle;

Optional: style applied to central hub.

nodeStyle

Property nodeStyle As %ZEN.Datatype.svgStyle;

Optional: style applied to nodes.

scaleNodes

Property scaleNodes As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Optional: if true, then scale the size of the outer nodes proportionally to their value.

selectedIndex

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.

onselectNode

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;

XDatas

SVGStyle

XData SVGStyle

Methods

renderContents

ClientMethod renderContents() [ Language = javascript ]

Render the inner SVG contents of this component.

drawConnector

ClientMethod drawConnector(group, angle) [ Language = javascript ]

Draw a connector.

drawNode

ClientMethod drawNode(group, type, angle, node, num, size) [ Language = javascript ]

Draw a node.

selectNode

ClientMethod selectNode(index) [ Language = javascript ]

Select the specified node.

nodeMouseHandler

ClientMethod nodeMouseHandler(evt, flag, nodeIndex) [ Language = javascript ]

Highlight/unhighlight node (called by mouseover, mouseout events).

nodeClickHandler

ClientMethod nodeClickHandler(evt, type, nodeIndex) [ Language = javascript ]

Onclick handler for nodes.

clearNodes

ClientMethod clearNodes() [ Language = javascript ]

Remove the set of nodes associated with this Navigator.

getCurrNode

ClientMethod getCurrNode() [ Language = javascript ]

Return the current selected node object associated with this Navigator.

getNode

ClientMethod getNode(index) [ Language = javascript ]

Return a node object associated with this Navigator given its index number (0-based).

removeNode

ClientMethod removeNode(index) [ Language = javascript ]

Remove a node from this navigator.
index is the index number (0-based) of the node.

appendNode

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');

setProperty

ClientMethod setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.