Package de.gsi.chart.renderer

Interface Renderer

All Known Implementing Classes:

AbstractContourDataSetRendererParameter, AbstractDataSetManagement, AbstractErrorDataSetRendererParameter, AbstractPointReductionManagment, ContourDataSetRenderer, ErrorDataSetRenderer, GridRenderer, HistogramRenderer, HistoryDataSetRenderer, LabelledMarkerRenderer, MetaDataRenderer, MountainRangeRenderer, ReducingLineRenderer

public interface Renderer

-- generic renderer interface --

Author:

braeun, rstein

Method Summary

Modifier and Type	Method	Description
javafx.scene.canvas.Canvas	drawLegendSymbol(de.gsi.dataset.DataSet dataSet, int dsIndex, int width, int height)
javafx.collections.ObservableList<Axis>	getAxes()
javafx.collections.ObservableList<de.gsi.dataset.DataSet>	getDatasets()
javafx.collections.ObservableList<de.gsi.dataset.DataSet>	getDatasetsCopy()
java.util.List<de.gsi.dataset.DataSet>	render(javafx.scene.canvas.GraphicsContext gc, Chart chart, int dataSetOffset, javafx.collections.ObservableList<de.gsi.dataset.DataSet> datasets)
Renderer	setShowInLegend(boolean state)	Sets whether DataSets attached to this renderer shall be shown in the legend
boolean	showInLegend()	Sets whether DataSets attached to this renderer shall be shown in the legend
javafx.beans.property.BooleanProperty	showInLegendProperty()	Sets whether DataSets attached to this renderer shall be shown in the legend

Method Detail

drawLegendSymbol

javafx.scene.canvas.Canvas drawLegendSymbol(de.gsi.dataset.DataSet dataSet,
                                            int dsIndex,
                                            int width,
                                            int height)

Parameters:

dataSet - the data set for which the representative icon should be generated

dsIndex - index within renderer set

width - requested width of the returning Canvas

height - requested height of the returning Canvas

Returns:

a graphical icon representation of the given data sets

getAxes

javafx.collections.ObservableList<Axis> getAxes()

Returns:

observable list of axes that are supposed to be used by the renderer

getDatasets

javafx.collections.ObservableList<de.gsi.dataset.DataSet> getDatasets()

getDatasetsCopy

javafx.collections.ObservableList<de.gsi.dataset.DataSet> getDatasetsCopy()

render

java.util.List<de.gsi.dataset.DataSet> render(javafx.scene.canvas.GraphicsContext gc,
                                              Chart chart,
                                              int dataSetOffset,
                                              javafx.collections.ObservableList<de.gsi.dataset.DataSet> datasets)

Parameters:

gc - the Canvas' GraphicsContext the renderer should draw upon

chart - the corresponding chart

dataSetOffset - global offset of the last drawn DataSet

datasets - list of globally (ie. in Chart) stored DataSets

Returns:

List of drawn DataSets (N.B. return '0' in case showInLegend() is false)

setShowInLegend

Renderer setShowInLegend(boolean state)

Sets whether DataSets attached to this renderer shall be shown in the legend

Parameters:

state - true (default) if data sets are supposed to be drawn

Returns:

the renderer class

showInLegend

boolean showInLegend()

Sets whether DataSets attached to this renderer shall be shown in the legend

Returns:

true (default) if data sets are supposed to be drawn

showInLegendProperty

javafx.beans.property.BooleanProperty showInLegendProperty()

Sets whether DataSets attached to this renderer shall be shown in the legend

Returns:

true (default) if data sets are supposed to be drawn