Package com.amalgamasimulation.charts

Class TimeLineChart

java.lang.Object

com.amalgamasimulation.charts.Chart<ILineChartVisualSet,LineVisualSetContainer>

com.amalgamasimulation.charts.AbstractLineChart

com.amalgamasimulation.charts.TimeLineChart

All Implemented Interfaces:

IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

public final class TimeLineChart
extends AbstractLineChart

A chart is a GUI component based on JavaFX's XYChart class that can be used to conveniently draw numeric and statistical data. All charts are designed to be compatible with Eclipse RCP applications and SWT framework. A Time Line Chart is used to show linear plots or clouds of points in two-dimensional coordinates with Time-related X-axis.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected Legend<ILineChartVisualSet>	legend
protected LineChartTimeXAxis	xAxis
protected LineChartNumericYAxis	yAxis

Fields inherited from class com.amalgamasimulation.charts.AbstractLineChart

internalLineChart

Constructor Summary

Constructors

Constructor	Description
TimeLineChart(IChartEnvironment chartEnvironment)	Constructs a Line Chart with a set of default parameters: no title, daily time units, begin displayed range is equals to 7 days.
TimeLineChart(IChartEnvironment chartEnvironment, String title, ChronoUnit timeUnit)	Constructs a Line Chart with given title and time units.
TimeLineChart(IChartEnvironment chartEnvironment, String title, ChronoUnit timeUnit, ChronoUnit beginWindowSizeChronoUnit, double beginWindowSize)	Constructs a Line Chart with manually setting of all initialization parameters.
TimeLineChart(IChartEnvironment chartEnvironment, ChronoUnit timeUnit)	Constructs a Line Chart with given time units and a set of default parameters: no title, begin displayed range is equals to 7 days.
TimeLineChart(IChartEnvironment chartEnvironment, ChronoUnit timeUnit, ChronoUnit beginWindowSizeChronoUnit, double beginWindowSize)	Constructs a Line Chart with given horizontal axis time units and begin displayed range.

Method Summary

Modifier and Type	Method	Description
Legend<ILineChartVisualSet>	getLegend()	Returns the Legend currently shown on this chart.
LineChartTimeXAxis	getXAxis()	Returns the X-axis of this chart.
LineChartNumericYAxis	getYAxis()	Returns the Y-axis of this chart.

Methods inherited from class com.amalgamasimulation.charts.AbstractLineChart

addContextMenuItem, addVerticalGuidelineChangeHandler, clearContextMenuItems, clearVerticalGuidelineChangeHandlers, getChartInternal, getVerticalGuidelineColor, getVerticalGuidelineLabelFormat, getVerticalGuidelinePosition, getVerticalGuidelineWidth, hideVerticalGuideline, isVerticalGuidelineDisplayed, isVerticalGuidelineLabelVisible, isVerticalGuidelineSnapToGridLines, isVerticalGuidelineValuesVisible, isVerticalGuidelineVisible, removeContextMenuItem, removeVerticalGuidelineChangeHandler, setArgumentClipboardFormatter, setVerticalGuidelineColor, setVerticalGuidelineColor, setVerticalGuidelineLabelFormat, setVerticalGuidelineLabelVisible, setVerticalGuidelineSnapToGridLines, setVerticalGuidelineValuesVisible, setVerticalGuidelineVisible, setVerticalGuidelineWidth, showVerticalGuidelineDisplayed

Methods inherited from class com.amalgamasimulation.charts.Chart

addKeyPressedHandler, addKeyReleasedHandler, addMouseDragExitedHandler, addMouseDraggedHandler, addMouseDragOverHandler, addMouseDragReleasedHandler, addMouseEnteredHandlers, addMouseExitedHandler, addMousePressedHandler, addMouseReleasedHandler, addMouseScrollHandler, addRedrawFinishedHandler, addTextLabel, addTextLabel, clearKeyPressedHandlers, clearKeyReleasedHandlers, clearMouseDragExitedHandlers, clearMouseDraggedHandlers, clearMouseDragOverHandlers, clearMouseDragReleasedHandlers, clearMouseEnteredHandlers, clearMouseExitedHandlers, clearMousePressedHandlers, clearMouseReleasedHandlers, clearMouseScrollHandlers, clearRedrawFinishedHandlers, copyToClipboard, dispose, getBackgroundColor, getBottomMargin, getContentBackgroundColor, getLeftMargin, getTitle, getTitleColor, getTitleFont, getTitleFontSize, getTopMargin, getVisualSetContainer, initializeChartGroup, isDisposed, isRedrawInProgress, isTitleVisible, isVisible, isVisualSetVisible, redraw, removeKeyPressedHandler, removeKeyReleasedHandler, removeMouseDragExitedHandler, removeMouseDraggedHandler, removeMouseDragOverHandler, removeMouseDragReleasedHandler, removeMouseEnteredHandler, removeMouseExitedHandler, removeMousePressedHandler, removeMouseReleasedHandler, removeMouseScrollHandler, removeRedrawFinishedHandler, removeTextLabel, resizeChart, setBackgroundColor, setBackgroundColor, setBottomMargin, setContentBackgroundColor, setContentBackgroundColor, setContextMenuVisible, setCopyToClipboardContextMenuItemVisible, setLeftMargin, setTitle, setTitleColor, setTitleColor, setTitleFont, setTitleFontSize, setTitleVisible, setTopMargin, setVisibility, setVisualSetContainer, setVisualSetVisible, updateSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

xAxis

protected LineChartTimeXAxis xAxis

yAxis

protected LineChartNumericYAxis yAxis

legend

protected Legend<ILineChartVisualSet> legend

Constructor Details

TimeLineChart

public TimeLineChart(IChartEnvironment chartEnvironment)

Constructs a Line Chart with a set of default parameters: no title, daily time units, begin displayed range is equals to 7 days.

Parameters:

chartEnvironment - parent environment, that is a layer between the parent subtype of IChartEnvironment and this chart

TimeLineChart

public TimeLineChart(IChartEnvironment chartEnvironment,
 ChronoUnit timeUnit)

Constructs a Line Chart with given time units and a set of default parameters: no title, begin displayed range is equals to 7 days.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

timeUnit - chart horizontal axis time units

TimeLineChart

public TimeLineChart(IChartEnvironment chartEnvironment,
 String title,
 ChronoUnit timeUnit)

Constructs a Line Chart with given title and time units. Begin displayed range is equals to 7 days and title is not set.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

title - chart title i.e. label written above the chart

timeUnit - chart horizontal axis time units

TimeLineChart

public TimeLineChart(IChartEnvironment chartEnvironment,
 ChronoUnit timeUnit,
 ChronoUnit beginWindowSizeChronoUnit,
 double beginWindowSize)

Constructs a Line Chart with given horizontal axis time units and begin displayed range. Title is not set.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

timeUnit - chart horizontal axis time units

beginWindowSizeChronoUnit - chart begin displayed range time units

beginWindowSize - chart begin displayed range

TimeLineChart

public TimeLineChart(IChartEnvironment chartEnvironment,
 String title,
 ChronoUnit timeUnit,
 ChronoUnit beginWindowSizeChronoUnit,
 double beginWindowSize)

Constructs a Line Chart with manually setting of all initialization parameters.

Parameters:

chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

title - chart title i.e. label written above the chart

timeUnit - chart horizontal axis time units

beginWindowSizeChronoUnit - chart begin displayed range time units

beginWindowSize - chart begin displayed range

Method Details

getXAxis

public LineChartTimeXAxis getXAxis()

Description copied from class: Chart

Returns the X-axis of this chart.

Specified by:

getXAxis in class Chart<ILineChartVisualSet,LineVisualSetContainer>

Returns:

the X-axis of this chart

getYAxis

public LineChartNumericYAxis getYAxis()

Description copied from class: Chart

Returns the Y-axis of this chart.

Specified by:

getYAxis in class Chart<ILineChartVisualSet,LineVisualSetContainer>

Returns:

the Y-axis of this chart

getLegend

public Legend<ILineChartVisualSet> getLegend()

Description copied from class: AbstractLineChart

Returns the Legend currently shown on this chart.

Specified by:

getLegend in class AbstractLineChart

Returns:

the Legend currently shown on this chart