org.pepstock.charba.client.data

Class LineDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.LiningDataset

org.pepstock.charba.client.data.LineDataset

All Implemented Interfaces:

HasDataPoints, HasDataset, HasPointFillStrokeStyles, HasFill

Direct Known Subclasses:

ScatterDataset, StackedAreaDataset, TimeSeriesLineDataset

public class LineDataset
extends LiningDataset
implements HasDataPoints

The line chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
All point* properties can be specified as an array. If these are set to an array value, the first value applies to the first point, the second value to the second point, and so on.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
	LineDataset() Creates a dataset. It uses the global options has default.
	LineDataset(IsDefaultOptions defaultValues) Creates the dataset using a default.
protected	LineDataset(Type type) Creates the dataset using chart type related to the dataset.
protected	LineDataset(Type type, IsDefaultOptions defaultValues) Creates the dataset using a default and chart type related to the dataset.

Method Summary

Modifier and Type	Method and Description
double	getClip() Returns how to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea.
Clip	getClipAsObject() Returns how to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea.
CubicInterpolationMode	getCubicInterpolationMode() Returns algorithm used to interpolate a smooth curve from the discrete data points.
CubicInterpolationModeCallback	getCubicInterpolationModeCallback() Returns the border join style callback, if set, otherwise null.
List<String>	getDataString() Returns the data property of a dataset for a chart is specified as an array of strings.
List<String>	getDataString(boolean binding) Returns the data property of a dataset for a chart is specified as an array of strings.
default int	getOrder() Returns the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
SteppedLine	getSteppedLine() Returns if the line is shown as a stepped line.
String	getXAxisID() Returns the ID of the x axis to plot this dataset on.
String	getYAxisID() Returns the ID of the y axis to plot this dataset on.
boolean	isShowLine() Returns if the line is not drawn for this dataset.
void	setClip(Clip clip) Sets how to clip relative to chartArea, by an object which configures clipping per side. Positive value allows overflow, negative value clips that many pixels inside chartArea.
void	setClip(double clip) Sets how to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea.
void	setCubicInterpolationMode(CubicInterpolationMode mode) Sets algorithm used to interpolate a smooth curve from the discrete data points. The following interpolation modes are supported:
void	setCubicInterpolationMode(CubicInterpolationModeCallback cubicInterpolationModeCallback) Sets the border join style callback.
void	setDataString(List<String> data) Sets the data property of a dataset for a chart is specified as an array of strings.
void	setDataString(String... data) Sets the data property of a dataset for a chart is specified as an array of strings.
default void	setOrder(int order) Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
void	setShowLine(boolean showLine) Sets if the line is not drawn for this dataset.
void	setSteppedLine(boolean line) Sets if the line is shown as a stepped line. If the steppedLine value is set to anything other than false, lineTension will be ignored.
void	setSteppedLine(SteppedLine line) Sets if the line is shown as a stepped line. If the steppedLine value is set to anything other than false, lineTension will be ignored.
void	setXAxisID(String xAxisID) Sets the ID of the x axis to plot this dataset on.
void	setYAxisID(String yAxisID) Sets the ID of the y axis to plot this dataset on.

Methods inherited from class org.pepstock.charba.client.data.LiningDataset

applyGradient, applyPattern, getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPattern, getBackgroundColorAsString, getBorderCapStyle, getBorderCapStyleCallback, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getBorderDash, getBorderDashCallback, getBorderDashOffset, getBorderDashOffsetCallback, getBorderJoinStyle, getBorderJoinStyleCallback, getBorderWidth, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getFill, getFillCallback, getFiller, getHoverBackgroundColor, getHoverBackgroundColorAsGradient, getHoverBackgroundColorAsPatterns, getHoverBackgroundColorAsString, getHoverBorderCapStyle, getHoverBorderCapStyleCallback, getHoverBorderColor, getHoverBorderColorAsGradient, getHoverBorderColorAsString, getHoverBorderDash, getHoverBorderDashCallback, getHoverBorderDashOffset, getHoverBorderDashOffsetCallback, getHoverBorderJoinStyle, getHoverBorderJoinStyleCallback, getHoverBorderWidth, getLabel, getLineTension, getOrderer, getPointBackgroundColor, getPointBackgroundColorAsGradient, getPointBackgroundColorAsString, getPointBackgroundColorCallback, getPointBorderColor, getPointBorderColorAsGradient, getPointBorderColorAsString, getPointBorderColorCallback, getPointBorderWidth, getPointBorderWidthCallback, getPointFillStyleProperty, getPointHitRadius, getPointHitRadiusCallback, getPointHoverBackgroundColor, getPointHoverBackgroundColorAsGradient, getPointHoverBackgroundColorAsString, getPointHoverBackgroundColorCallback, getPointHoverBorderColor, getPointHoverBorderColorAsGradient, getPointHoverBorderColorAsString, getPointHoverBorderColorCallback, getPointHoverBorderWidth, getPointHoverBorderWidthCallback, getPointHoverRadius, getPointHoverRadiusCallback, getPointRadius, getPointRadiusCallback, getPointRotation, getPointRotationCallback, getPointStrokeStyleProperty, getPointStyle, getPointStyleAsImages, getPointStyleCallback, isSpanGaps, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderCapStyle, setBorderCapStyle, setBorderColor, setBorderColor, setBorderColor, setBorderDash, setBorderDash, setBorderDashOffset, setBorderDashOffset, setBorderJoinStyle, setBorderJoinStyle, setBorderWidth, setFill, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderCapStyle, setHoverBorderCapStyle, setHoverBorderColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderDash, setHoverBorderDash, setHoverBorderDashOffset, setHoverBorderDashOffset, setHoverBorderJoinStyle, setHoverBorderJoinStyle, setHoverBorderWidth, setLineTension, setPointBackgroundColor, setPointBackgroundColor, setPointBackgroundColor, setPointBackgroundColor, setPointBorderColor, setPointBorderColor, setPointBorderColor, setPointBorderColor, setPointBorderWidth, setPointBorderWidth, setPointHitRadius, setPointHitRadius, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderWidth, setPointHoverBorderWidth, setPointHoverRadius, setPointHoverRadius, setPointRadius, setPointRadius, setPointRotation, setPointRotation, setPointStyle, setPointStyle, setPointStyle, setPointStyle, setPointStyle, setSpanGaps

Methods inherited from class org.pepstock.charba.client.data.Dataset

getBackgroundColorCallback, getBorderColorCallback, getBorderWidthCallback, getData, getData, getDataset, getDataType, getDefaultValues, getHoverBackgroundColorCallback, getHoverBorderColorCallback, getHoverBorderWidthCallback, getId, getOptions, getOptions, getType, hasOptions, invokeColorCallback, isHidden, removeOptions, setBackgroundColor, setBorderColor, setBorderWidth, setData, setData, setHidden, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderWidth, setLabel, setOptions, setOptions

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.data.HasDataPoints

getDataPoints, getDataPoints, setDataPoints, setDataPoints

Methods inherited from interface org.pepstock.charba.client.data.HasDataset

getDataset

Methods inherited from interface org.pepstock.charba.client.enums.HasFill

setFill, setFill, setFill, setFill

Constructor Detail

LineDataset

public LineDataset()

Creates a dataset.
It uses the global options has default.

LineDataset

public LineDataset(IsDefaultOptions defaultValues)

Creates the dataset using a default.

Parameters:

defaultValues - default options

LineDataset

protected LineDataset(Type type)

Creates the dataset using chart type related to the dataset.

Parameters:

type - chart type related to the dataset

LineDataset

protected LineDataset(Type type,
                      IsDefaultOptions defaultValues)

Creates the dataset using a default and chart type related to the dataset.

Parameters:

type - chart type related to the dataset

defaultValues - default options

Method Detail

setXAxisID

public void setXAxisID(String xAxisID)

Sets the ID of the x axis to plot this dataset on.

Parameters:

xAxisID - the ID of the x axis to plot this dataset on.

getXAxisID

public String getXAxisID()

Returns the ID of the x axis to plot this dataset on.

Returns:

the ID of the x axis to plot this dataset on. Default is Scales.DEFAULT_X_AXIS_ID

setYAxisID

public void setYAxisID(String yAxisID)

Sets the ID of the y axis to plot this dataset on.

Parameters:

yAxisID - the ID of the y axis to plot this dataset on.

getYAxisID

public String getYAxisID()

Returns the ID of the y axis to plot this dataset on.

Returns:

the ID of the y axis to plot this dataset on. Default is Scales.DEFAULT_Y_AXIS_ID

setCubicInterpolationMode

public void setCubicInterpolationMode(CubicInterpolationMode mode)

Sets algorithm used to interpolate a smooth curve from the discrete data points.
The following interpolation modes are supported:

 'default'
 'monotone'
 

The 'default' algorithm uses a custom weighted cubic interpolation, which produces pleasant curves for all types of datasets.
The 'monotone' algorithm is more suited to y = f(x) datasets : it preserves monotonicity (or piecewise monotonicity) of the dataset being interpolated, and ensures local extremums (if any) stay at input data points.

Parameters:

mode - algorithm used to interpolate a smooth curve from the discrete data points

getCubicInterpolationMode

public CubicInterpolationMode getCubicInterpolationMode()

Returns algorithm used to interpolate a smooth curve from the discrete data points.

Returns:

algorithm used to interpolate a smooth curve from the discrete data points.

setShowLine

public void setShowLine(boolean showLine)

Sets if the line is not drawn for this dataset.

Parameters:

showLine - false if the line is not drawn for this dataset.

isShowLine

public boolean isShowLine()

Returns if the line is not drawn for this dataset.

Returns:

false if the line is not drawn for this dataset.

setSteppedLine

public void setSteppedLine(boolean line)

Sets if the line is shown as a stepped line.
If the steppedLine value is set to anything other than false, lineTension will be ignored.

Parameters:

line - if the line is shown as a stepped line. false is no step interpolation

setSteppedLine

public void setSteppedLine(SteppedLine line)

Sets if the line is shown as a stepped line.
If the steppedLine value is set to anything other than false, lineTension will be ignored.

Parameters:

line - if the line is shown as a stepped line.

getSteppedLine

public SteppedLine getSteppedLine()

Returns if the line is shown as a stepped line.

Returns:

If the line is shown as a stepped line.

setClip

public void setClip(double clip)

Sets how to clip relative to chartArea.
Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea.

Parameters:

clip - positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea

setClip

public void setClip(Clip clip)

Sets how to clip relative to chartArea, by an object which configures clipping per side.
Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea.

Parameters:

clip - object which configures clipping per side

getClip

public double getClip()

Returns how to clip relative to chartArea.
Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea.
If the clip was set by a Clip object, returns UndefinedValues.DOUBLE.

Returns:

positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea.
If the clip was set by a Clip object, returns UndefinedValues.DOUBLE

getClipAsObject

public Clip getClipAsObject()

Returns how to clip relative to chartArea.
Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea.
If the clip was NOT set by a Clip object, returns a Clip instance with the same values.

Returns:

clip positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea.
If the clip was NOT set by a Clip object, returns a Clip instance with the same values.

setDataString

public void setDataString(String... data)

Sets the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.

Parameters:

data - an array of strings

setDataString

public void setDataString(List<String> data)

Sets the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.

Parameters:

data - a list of strings

getDataString

public List<String> getDataString()

Returns the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.

Returns:

a list of strings or an empty list of strings if the data type is not DataType.STRINGS.

getDataString

public List<String> getDataString(boolean binding)

Returns the data property of a dataset for a chart is specified as an array of strings. Each point in the data array corresponds to the label at the same index on the x axis.

Parameters:

binding - if true binds the new array list into container

Returns:

a list of strings or an empty list of strings if the data type is not DataType.STRINGS.

getCubicInterpolationModeCallback

public CubicInterpolationModeCallback getCubicInterpolationModeCallback()

Returns the border join style callback, if set, otherwise null.

Returns:

the border join style callback, if set, otherwise null.

setCubicInterpolationMode

public void setCubicInterpolationMode(CubicInterpolationModeCallback cubicInterpolationModeCallback)

Sets the border join style callback.

Parameters:

cubicInterpolationModeCallback - the border join style callback.

setOrder

public void setOrder(int order)

Sets the drawing order of dataset.
Also affects order for stacking, tooltip, and legend.

Parameters:

order - the drawing order of dataset.

getOrder

public int getOrder()

Returns the drawing order of dataset.
Also affects order for stacking, tooltip, and legend.

Returns:

the drawing order of dataset