desmoj.core.report.html5chart

Class CanvasHistogramLong

java.lang.Object

desmoj.core.simulator.NamedObject

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

desmoj.core.report.html5chart.AbstractNumericalCoorChartCanvas<java.lang.Long>

desmoj.core.report.html5chart.AbstractNumericalCoorChartCanvasLong

desmoj.core.report.html5chart.CanvasHistogramLong

All Implemented Interfaces:

Canvas, CanvasCoordinateChart<java.lang.Long>

public class CanvasHistogramLong
extends AbstractNumericalCoorChartCanvasLong

A canvas to display the data from a Histogram.

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
CanvasHistogramLong(java.lang.String canvasName, int canvasHeight, int canvasWidth, ChartDataHistogramLong textHistData, java.lang.String xText) Create a Canvas for TextHistogram.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getDataValue(int index) Returns the value of the data at a specified index.
long	getNumOfXScale() Returns the number of scales to be shown on the x-axis.
java.lang.Long	getStartXScale() Returns the value for the first scale on the x-axis (the scale most left of the chart).
java.lang.String	getText(int index) Returns the observed text at the given index.
java.lang.String	getXAxisTitle() Returns the title for the x-axis.
java.lang.Long	getXScale() Returns the difference between each scale on the x-axis.
java.lang.String	getYAxisTitle() Returns the title for the y-axis.

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

getDataColor, getNumOfData, getNumOfYScale, getYScale

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, getRightGap, getScaleLineColor, getTopGap

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

getCanvasHeight, getCanvasID, getCanvasWidth, getDefaultColor

Constructor Detail

CanvasHistogramLong

public CanvasHistogramLong(java.lang.String canvasName,
                           int canvasHeight,
                           int canvasWidth,
                           ChartDataHistogramLong textHistData,
                           java.lang.String xText)

Create a Canvas for TextHistogram.

Parameters:

canvasName - The name of the canvas.

canvasHeight - The height of the canvas.

canvasWidth - The width of the canvas.

data - The data of the TextHistogram to be displayed in this canvas.

data - Text at the x-axis

Method Detail

getNumOfXScale

public long getNumOfXScale()

Description copied from interface: CanvasCoordinateChart

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

Returns:

getXScale

public java.lang.Long getXScale()

Description copied from interface: CanvasCoordinateChart

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

Returns:

getStartXScale

public java.lang.Long getStartXScale()

Description copied from interface: CanvasCoordinateChart

Returns the value for the first scale on the x-axis (the scale most left of the chart).

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:

getDataValue

public java.lang.Long getDataValue(int index)

Returns the value of the data at a specified index.

Parameters:

index - The index of the data.

Returns:

Long :

getText

public java.lang.String getText(int index)

Returns the observed text at the given index.

Parameters:

index - int : The index of the String asked for

Returns:

String : The observed text at the given index