desmoj.core.report.html5chart

Class CanvasTimeSeries

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.report.html5chart.AbstractNumericalChartCanvas<java.lang.Double>

desmoj.core.report.html5chart.CanvasTimeSeries

All Implemented Interfaces:

Canvas, CanvasCoordinateChart<java.lang.Double>

public class CanvasTimeSeries
extends AbstractNumericalChartCanvas<java.lang.Double>

A canvas to display data from multiple TimeSeries.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Johanna Djimandjaja Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
CanvasTimeSeries(java.lang.String name, int canvasHeight, int canvasWidth, ChartDataTimeSeries timeSeriesData, java.lang.String axis_x, java.lang.String axis_y)

Method Summary

Modifier and Type	Method and Description
java.awt.Color	addTimeSeries(ChartDataTimeSeries timeSeries) Add a chart data of a TimeSeries to this canvas.
java.awt.Color	getDataColor(int i) Returns the color, that represents the TimeSEries at index i.
java.lang.Double[]	getDataValues(int i) Returns the data value of the TimeSeriesData at index i.
int	getNumOfData() Returns the number of TimeSeries displayed by this canvas.
int	getNumOfTimeSeries()
long	getNumOfXScale() Returns the number of scales to be shown on the x-axis.
long	getNumOfYScale() Returns the number of scales to be shown on the y-axis.
java.lang.Double	getStartXScale() Returns the number for the first xScale.
java.lang.Double[]	getTimeValues(int i) Returns the time value of the TimeSeriesData at index i.
java.lang.String	getXAxisTitle() Returns the title for the x-axis.
java.lang.Double	getXScale() Returns the difference between each scale on the x-axis.
java.lang.String	getYAxisTitle() Returns the title for the y-axis.
java.lang.Double	getYScale() Returns the difference between each scale on the y-axis.

Methods inherited from class desmoj.core.report.html5chart.AbstractNumericalChartCanvas

getBottomGap, getCanvasHeight, getCanvasID, getCanvasWidth, getChartHeight, getChartWidth, getDefaultColor, getLeftGap, getRightGap, getScaleLineColor, getTopGap

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CanvasTimeSeries

public CanvasTimeSeries(java.lang.String name,
                        int canvasHeight,
                        int canvasWidth,
                        ChartDataTimeSeries timeSeriesData,
                        java.lang.String axis_x,
                        java.lang.String axis_y)

Method Detail

addTimeSeries

public java.awt.Color addTimeSeries(ChartDataTimeSeries timeSeries)

Add a chart data of a TimeSeries to this canvas. The color will be defined to represent this TimeSeries in the canvas

Parameters:

timeSeries - ChartDataTimeSeries: the chart data of a TimeSeries to be added to this canvas

Returns:

Color: the color defined to represent this TimeSeries in the canvas

getDataColor

public java.awt.Color getDataColor(int i)

Returns the color, that represents the TimeSEries at index i.

Parameters:

i -

Returns:

getNumOfYScale

public long getNumOfYScale()

Returns the number of scales to be shown on the y-axis.

Returns:

getYScale

public java.lang.Double getYScale()

Returns the difference between each scale on the y-axis.

Returns:

getNumOfXScale

public long getNumOfXScale()

Returns the number of scales to be shown on the x-axis.

Returns:

getXScale

public java.lang.Double getXScale()

Returns the difference between each scale on the x-axis.

Returns:

getStartXScale

public java.lang.Double getStartXScale()

Returns the number for the first xScale.

Returns:

getNumOfTimeSeries

public int getNumOfTimeSeries()

getDataValues

public java.lang.Double[] getDataValues(int i)

Returns the data value of the TimeSeriesData at index i.

Parameters:

i -

Returns:

getTimeValues

public java.lang.Double[] getTimeValues(int i)

Returns the time value of the TimeSeriesData at index i.

Parameters:

i -

Returns:

getNumOfData

public int getNumOfData()

Returns the number of TimeSeries displayed by this canvas.

Returns:

getXAxisTitle

public java.lang.String getXAxisTitle()

Description copied from interface: CanvasCoordinateChart

Returns the title for the x-axis.

Returns:

getYAxisTitle

public java.lang.String getYAxisTitle()

Description copied from interface: CanvasCoordinateChart

Returns the title for the y-axis.

Returns: