org.askalon.graph.chart
Interface RibbonChart

All Superinterfaces:

Chart, Cleanable, DescriptionModeChart, NormalizeableChart, OrderedChart, SectionChart, UnalignedChart

public interface RibbonChart
extends NormalizeableChart, UnalignedChart, DescriptionModeChart, OrderedChart

Interface for the ribbon chart, providing access to basic functionality like the setting of values, visibility and accumulation.
The Ribbon Chart allows to display several courses of data as ribbons. The single ribbons can be accumulated, exchanged, hidden, normalized and transformed to solid "mountains".

Author:

Georg Schild and Franz Endstrasser

Method Summary

double[]	getDatapoints()
String	getDescription(int index) Gets the description for the given index
boolean	isAccumulated() Gets the state of the accumulated mode (ribbons are located on top of each other).
boolean	isSolid() Gets the state of the view: ribbon or solid.
void	removeEntity(int index) Removes the entity (ribbon) at the specified index.
void	setAccumulated(boolean b) Turn the accumulated mode (ribbons are located on top of each other) on or off.
void	setDatapoints(double[] datapoints) Sets the datapoint positions
void	setDescription(int index, String desc) Sets the description of the datapoint specified by index.
void	setSolid(boolean b) Enables or disables the ribbon/solid view.
void	setValue(int idx, int datapoint, double value) Sets the value of one ribbon's datapoint specified by the parameters.

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

isNormalized, setNormalized

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

getXLinesVisible, getZLinesVisible, setXLinesVisible, setZLinesVisible

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

getDescriptionMode, setDescriptionMode

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

decrementOrder, getOrder, incrementOrder, setOrder

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

setDescription

void setDescription(int index,
                    String desc)

Sets the description of the datapoint specified by index.

Parameters:

index - the index of the datapoint

desc - the new description to set

See Also:

DescriptionModeChart.setDescriptionMode(DescriptionMode), DescriptionModeChart.getDescriptionMode()

getDescription

String getDescription(int index)

Gets the description for the given index

Parameters:

index -

Returns:

description at index or null if there is no description set up yet

setValue

void setValue(int idx,
              int datapoint,
              double value)

Sets the value of one ribbon's datapoint specified by the parameters.

Parameters:

idx - the index of the ribbon (starting from 0)

datapoint - the index of the datapoint (starting from 0)

value - the new value of this datapoint

removeEntity

void removeEntity(int index)

Removes the entity (ribbon) at the specified index.

Parameters:

index - the index of the ribbon which should be removed

setAccumulated

void setAccumulated(boolean b)

Turn the accumulated mode (ribbons are located on top of each other) on or off.

Parameters:

b - true to activate accumulated mode, false to disable it

See Also:

isAccumulated()

setSolid

void setSolid(boolean b)

Enables or disables the ribbon/solid view.

Parameters:

b - true to activate the ribbon view, false to activate the solid view

See Also:

isSolid()

isSolid

boolean isSolid()

Gets the state of the view: ribbon or solid.

Returns:

true if the solid mode is activated, false if we are currently in the ribbon mode

isAccumulated

boolean isAccumulated()

Gets the state of the accumulated mode (ribbons are located on top of each other).

Returns:

true if ribbons are accumulated, false if they are placed sequentially

setDatapoints

void setDatapoints(double[] datapoints)

Sets the datapoint positions

Parameters:

datapoints -

getDatapoints

double[] getDatapoints()

Returns:

the datapoint positions