org.askalon.graph.chart
Interface XYChart

All Superinterfaces:

Chart, Cleanable, SectionChart, XYXMLChart

public interface XYChart
extends XYXMLChart

Interface for the XY chart, which can show nodes with x/y coordinates from a variable number of datasets.
It is a standard X/Y diagram where both axes represent real numbers. A diagram may contain several datasets (a sequence of data points), and data points from one dataset can be linked to their predecessors/successors with lines.

Author:

Georg Schild and Franz Endstrasser

Method Summary

void	addSetValue(int idx, String elementID, double xvalue, double yvalue) Adds a new node to the given dataset (entity) at the specified coordinates.
String	getDescription(int section, String id) Gets the description of a given node.
double[]	getValues(int idx, String elementID) Returns the values of section idx, element elementID
boolean	isNodesShown() Gets the current visibility of the nodes objects.
void	removeDataSet(int id) Removes the whole dataset specified by the id and all its nodes.
void	setDescription(int section, String id, String description) Sets the description of a node.
void	setNodesShown(boolean b) Enables/disables the visibility of all nodes.

Methods inherited from interface org.askalon.graph.chart.XYXMLChart

getLinkLineWidth, getNodeType, setLinkLineWidth, setNodeType

Methods inherited from interface org.askalon.graph.chart.SectionChart

getSectionColor, getSectionCount, getSectionName, isVisible, setSectionColor, setSectionName, setVisible

Methods inherited from interface org.askalon.graph.chart.Chart

getChartConfiguration, getChartMenu, getChartName, getLegend, getUnit, getXAxisText, getYAxisText, isDisableUpdate, isEdgesVisible, refreshConfiguration, resetConfiguration, setChartConfiguration, setDisableUpdate, setEdgesVisible, setUnit, setXAxisText, setYAxisText

Methods inherited from interface org.askalon.graph.chart.base.Cleanable

cleanUp

Method Detail

addSetValue

void addSetValue(int idx,
                 String elementID,
                 double xvalue,
                 double yvalue)

Adds a new node to the given dataset (entity) at the specified coordinates.

Parameters:

idx - id of the entity, to which the node should be added

elementID - id of the node

xvalue - x-coordinate of the node

yvalue - y-coordinate of the node

getValues

double[] getValues(int idx,
                   String elementID)

Returns the values of section idx, element elementID

Parameters:

idx -

elementID -

Returns:

values for chosen element (index 0: x value, index 1: y value) or null if the element doesn't exist

removeDataSet

void removeDataSet(int id)

Removes the whole dataset specified by the id and all its nodes.

Parameters:

id - the id of the dataset to remove

setDescription

void setDescription(int section,
                    String id,
                    String description)

Sets the description of a node.

Parameters:

section - the id of the dataset containing the node

id - the id of the node

description - the new description text for this node

getDescription

String getDescription(int section,
                      String id)

Gets the description of a given node.

Parameters:

section - the id of the dataset containing the node

id - the id of the node

Returns:

the assigned description of this node

setNodesShown

void setNodesShown(boolean b)

Enables/disables the visibility of all nodes.

Parameters:

b - true to show the nodes, false to hide them

See Also:

isNodesShown()

isNodesShown

boolean isNodesShown()

Gets the current visibility of the nodes objects.

Returns:

true if the nodes are visible, false otherwise

See Also:

setNodesShown(boolean)