desmoj.core.report.html5chart

Class AbstractNumericalCoorChartCanvas<N extends java.lang.Number>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.report.html5chart.AbstractNumericalChartCanvas<N>

desmoj.core.report.html5chart.AbstractNumericalCoorChartCanvas<N>

All Implemented Interfaces:

Canvas, CanvasCoordinateChart<N>

Direct Known Subclasses:

AbstractNumericalCoorChartCanvasDouble, AbstractNumericalCoorChartCanvasLong

public abstract class AbstractNumericalCoorChartCanvas<N extends java.lang.Number>
extends AbstractNumericalChartCanvas<N>
implements CanvasCoordinateChart<N>

A Chart with a numerical scale (only) on the y-axis.

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
AbstractNumericalCoorChartCanvas(java.lang.String canvasID, int canvasHeight, int canvasWidth, AbstractChartData<N> data) Create a canvas.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getDataColor(int index) Returns the color, that represents the data in cell n.
int	getNumOfData() Returns the number of data.
long	getNumOfYScale() Returns the number of scales to be shown on the y-axis.
N	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

Methods inherited from interface desmoj.core.report.html5chart.CanvasCoordinateChart

getBottomGap, getChartHeight, getChartWidth, getLeftGap, getNumOfXScale, getRightGap, getScaleLineColor, getStartXScale, getTopGap, getXAxisTitle, getXScale, getYAxisTitle

Methods inherited from interface desmoj.core.report.html5chart.Canvas

getCanvasHeight, getCanvasID, getCanvasWidth, getDefaultColor

Constructor Detail

AbstractNumericalCoorChartCanvas

public AbstractNumericalCoorChartCanvas(java.lang.String canvasID,
                                        int canvasHeight,
                                        int canvasWidth,
                                        AbstractChartData<N> data)

Create a canvas.

Parameters:

canvasID - The ID of this canvas.

canvasHeight - The height of this canvas.
Should be larger then this.getTopGap() + this.getBottomGap() + 100.

canvasWidth - The width of this canvas.
Should be larger then this.getLeftGap() + this.getRightGap() + 100.

Method Detail

getDataColor

public java.awt.Color getDataColor(int index)

Returns the color, that represents the data in cell n.

Specified by:

getDataColor in interface CanvasCoordinateChart<N extends java.lang.Number>

Parameters:

index - the index of the data, which color is asked for

Returns:

java.awt.Color : The color of the data at index n.

getNumOfData

public int getNumOfData()

Description copied from interface: CanvasCoordinateChart

Returns the number of data.

Specified by:

getNumOfData in interface CanvasCoordinateChart<N extends java.lang.Number>

Returns:

getNumOfYScale

public long getNumOfYScale()

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

Specified by:

getNumOfYScale in interface CanvasCoordinateChart<N extends java.lang.Number>

Returns:

getYScale

public N getYScale()

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

Specified by:

getYScale in interface CanvasCoordinateChart<N extends java.lang.Number>

Returns: