Package com.jbstrap.ui.components.charts

Class AxesBaseSeries

java.lang.Object

com.jbstrap.ui.components.charts.Series

com.jbstrap.ui.components.charts.AxesBaseSeries

Direct Known Subclasses:

AreaSeries, BarSeries, BubbleSeries, DotSeries, GaugeSeries, LineSeries

public abstract class AxesBaseSeries
extends Series

Parent class of series objects applicable for axis-based charts.

Since:

4.0

Author:

JBStrap

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VALUE_TANGENT

Fields inherited from class com.jbstrap.ui.components.charts.Series

CATEGORY_COLUMN, COLOR_COLUMN, colorColumn, DATA_COLUMN, dataColumn, LABEL_COLUMN, labelColumn, MARKER_SIZE, MARKER_TYPE, param, parentChart

Constructor Summary

Constructors

Constructor	Description
AxesBaseSeries(String title)	Creates an axis-based series object.
AxesBaseSeries(String title, String dataColumn)	Creates an axis-based series object and sets the name of the column.

Method Summary

Modifier and Type	Method	Description
boolean	isShowCategoryValueTangent()	Checks if the gridlines on the X axis are displayed.
boolean	isShowSeriesValueTangent()	Checks if the gridlines on the Y axis are displayed.
AxesBaseSeries	setShowCategoryValueTangent(boolean showCategoryValueTangent)	Turns the tangent line on the X axis on / off.
AxesBaseSeries	setShowSeriesValueTangent(boolean showSeriesValueTangent)	Turns on/off the Y axis tangents.

Methods inherited from class com.jbstrap.ui.components.charts.Series

addData, addData, addData, addData, clear, getColorColumn, getData, getDataColumn, getLabelColumn, getMarker, getMarkerSize, getMarkerType, getParams, getTitle, getValues, isEmpty, refreshMarker, removeDataByCategory, removeDataByIndex, setColorColumn, setDataColumn, setLabelColumn, setMarkerSize, setMarkerType, setParams, setParentChart

Methods inherited from class java.lang.Object

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

Field Details

VALUE_TANGENT

public static final String VALUE_TANGENT

See Also:

• Constant Field Values

Constructor Details

AxesBaseSeries

public AxesBaseSeries(String title)

Creates an axis-based series object.

Parameters:

title - Series title (required)

Throws:

NullPointerException - Thrown if the specified axis name is null

AxesBaseSeries

public AxesBaseSeries(String title,
 String dataColumn)

Creates an axis-based series object and sets the name of the column.

Parameters:

title - Series title (required)

dataColumn - The name of the column that contains the data series in the DataDescriptor

Throws:

NullPointerException - Thrown if the specified series name is null

Method Details

setShowCategoryValueTangent

public AxesBaseSeries setShowCategoryValueTangent(boolean showCategoryValueTangent)

Turns the tangent line on the X axis on / off. Tangent line appear when the user hovers over a data point portion of the chart. The X-axis tangent line is enabled by default.

Parameters:

showCategoryValueTangent - If true is specified, the tangent is visible, otherwise not

Returns:

Series object

isShowCategoryValueTangent

public boolean isShowCategoryValueTangent()

Checks if the gridlines on the X axis are displayed.

Returns:

If true, the gridlines on the X axis are displayed if the user hovers with the mouse pointer over a data point, Otherwise not specified.

setShowSeriesValueTangent

public AxesBaseSeries setShowSeriesValueTangent(boolean showSeriesValueTangent)

Turns on/off the Y axis tangents. Gridlines are displayed if the user hovers over a data point part of the chart. Y axis tangents are enabled by default.

Parameters:

showSeriesValueTangent - If true is specified, the tangent line is visible, otherwise not

Returns:

Series object

isShowSeriesValueTangent

public boolean isShowSeriesValueTangent()

Checks if the gridlines on the Y axis are displayed.

Returns:

If true, the gridlines on the Y axis are displayed if the user hovers with the mouse pointer over a data point, Otherwise not specified.