desmoj.core.report.html5chart

Class AbstractNumericalChartCanvas<N extends java.lang.Number>

java.lang.Object

desmoj.core.simulator.NamedObject

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

All Implemented Interfaces:

Canvas, CanvasCoordinateChart<N>

Direct Known Subclasses:

AbstractNumericalCoorChartCanvas, CanvasTimeSeries

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

A general Chart environment with defined gaps between the canvas border and the actual chart.

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

Method Summary

Modifier and Type	Method and Description
int	getBottomGap() Returns the gap between the bottom border of the canvas and the chart.
int	getCanvasHeight() Gets the height of the canvas.
java.lang.String	getCanvasID() Returns the ID of the canvas.
int	getCanvasWidth() Gets the width of the canvas.
int	getChartHeight() Returns the height of the chart area.
int	getChartWidth() Returns the width of the chart area.
java.awt.Color	getDefaultColor() Returns the color for the canvas border and the axis.
int	getLeftGap() Returns the gap between the left border of the canvas and the chart.
int	getRightGap() Returns the gap between the right border of the canvas and the chart.
java.awt.Color	getScaleLineColor() Returns the color for the scales in the y-axis.
int	getTopGap() Returns the gap between the top border of the canvas and the chart.

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

getDataColor, getNumOfData, getNumOfXScale, getNumOfYScale, getStartXScale, getXAxisTitle, getXScale, getYAxisTitle, getYScale

Constructor Detail

AbstractNumericalChartCanvas

public AbstractNumericalChartCanvas(java.lang.String canvasID,
                                    int canvasHeight,
                                    int canvasWidth)

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

getCanvasHeight

public int getCanvasHeight()

Gets the height of the canvas.

Specified by:

getCanvasHeight in interface Canvas

Returns:

int : The height of the canvas.

getCanvasWidth

public int getCanvasWidth()

Gets the width of the canvas.

Specified by:

getCanvasWidth in interface Canvas

Returns:

int : The width of the canvas.

getCanvasID

public java.lang.String getCanvasID()

Description copied from interface: Canvas

Returns the ID of the canvas.

Specified by:

getCanvasID in interface Canvas

Returns:

getChartHeight

public int getChartHeight()

Description copied from interface: CanvasCoordinateChart

Returns the height of the chart area.

Specified by:

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

Returns:

getChartWidth

public int getChartWidth()

Description copied from interface: CanvasCoordinateChart

Returns the width of the chart area.

Specified by:

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

Returns:

getDefaultColor

public java.awt.Color getDefaultColor()

Returns the color for the canvas border and the axis.

Specified by:

getDefaultColor in interface Canvas

Returns:

getScaleLineColor

public java.awt.Color getScaleLineColor()

Returns the color for the scales in the y-axis.

Specified by:

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

Returns:

java.awt.Color : The color for the scales in the y-axis.

getTopGap

public int getTopGap()

Returns the gap between the top border of the canvas and the chart.

Specified by:

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

Returns:

int : Gap between the top border of the canvas and the chart.

getRightGap

public int getRightGap()

Returns the gap between the right border of the canvas and the chart.

Specified by:

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

Returns:

int : Gap between the right border of the canvas and the chart.

getBottomGap

public int getBottomGap()

Returns the gap between the bottom border of the canvas and the chart.

Specified by:

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

Returns:

int : Gap between the bottom border of the canvas and the chart.

getLeftGap

public int getLeftGap()

Returns the gap between the left border of the canvas and the chart.

Specified by:

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

Returns:

int : Gap between the left border of the canvas and the chart.