org.pepstock.charba.client.data

Class VerticalLineDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.LiningDataset

org.pepstock.charba.client.data.LineDataset

org.pepstock.charba.client.data.VerticalLineDataset

All Implemented Interfaces:

HasCallbackScope, HasDataPoints, HasDataset, HasPointFillStrokeStyles, IsDefaultAnimationContainer, IsDefaultAnimationTransition, IsDefaultFillHandler, HasAnimationOptions, HasFill, HasSpanGaps

public class VerticalLineDataset
extends LineDataset

The vertical line chart allows a number of properties to be specified for each data set.
These are used to set display properties for a specific data set.
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

Nested Class Summary

Nested classes/interfaces inherited from class org.pepstock.charba.client.data.Dataset

Dataset.CanvasObjectProperty, Dataset.CommonProperty

Field Summary

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

DEFAULT_HIDDEN, DEFAULT_NORMALIZED, DEFAULT_PARSING

Constructor Summary

Constructors

Modifier	Constructor and Description
	VerticalLineDataset() Creates a data set. It uses the global options has default.
	VerticalLineDataset(boolean hidden) Creates a data set. It uses the global options has default.
	VerticalLineDataset(IsDefaultOptions defaultValues) Creates the data set using a default.
	VerticalLineDataset(IsDefaultOptions defaultValues, boolean hidden) Creates the data set using a default.
protected	VerticalLineDataset(Type type, boolean hidden) Creates the data set using chart type related to the data set.
protected	VerticalLineDataset(Type type, IsDefaultOptions defaultValues, boolean hidden) Creates the data set using a default and chart type related to the data set.

Method Summary

Modifier and Type	Method and Description
default int	getOrder() Returns the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
default List<PointStyle>	getPointStyle() Returns the style of the point.
default List<Canvas>	getPointStyleAsCanvas() Returns the style of the point as canvas. If property is missing or not an canvas, returns null.
default List<Img>	getPointStyleAsImages() Returns the style of the point as image. If property is missing or not an image, returns null.
default PointStyleCallback	getPointStyleCallback() Returns the point style callback, if set, otherwise null.
default PointStyleType	getPointStyleType() Returns the type of point style.
void	setIndexAxis(IndexAxis indexAxis) Sets the base axis for the data set.
default void	setOrder(int order) Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
default void	setPointStyle(Canvas... pointStyle) Sets the style of the point as canvas.
default void	setPointStyle(Img... pointStyle) Sets the style of the point as image.
default void	setPointStyle(PointStyle... pointStyle) Sets the style of the point.
default void	setPointStyle(PointStyleCallback pointStyleCallback) Sets the point style callback.

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

getCubicInterpolationMode, getCubicInterpolationModeCallback, getDataString, getDataString, getIndexAxis, getStepped, getSteppedCallback, getXAxisID, getYAxisID, isShowLine, setCubicInterpolationMode, setCubicInterpolationMode, setCubicInterpolationMode, setDataString, setDataString, setShowLine, setStepped, setStepped, setStepped, setStepped, setXAxisID, setXAxisID, setYAxisID, setYAxisID

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

getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPattern, getBackgroundColorAsString, getBorderCapStyle, getBorderCapStyleCallback, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getBorderDash, getBorderDashCallback, getBorderDashOffset, getBorderDashOffsetCallback, getBorderJoinStyle, getBorderJoinStyleCallback, getBorderWidth, getBorderWidthCallback, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultHoverBackgroundColorAsString, getDefaultHoverBorderColorAsString, getDefaultHoverBorderWidth, getFill, getFillCallback, getFillHandler, getHoverBackgroundColor, getHoverBackgroundColorAsGradient, getHoverBackgroundColorAsPatterns, getHoverBackgroundColorAsString, getHoverBorderCapStyle, getHoverBorderCapStyleCallback, getHoverBorderColor, getHoverBorderColorAsGradient, getHoverBorderColorAsString, getHoverBorderDash, getHoverBorderDashCallback, getHoverBorderDashOffset, getHoverBorderDashOffsetCallback, getHoverBorderJoinStyle, getHoverBorderJoinStyleCallback, getHoverBorderWidth, getHoverBorderWidthCallback, getLabel, getOrderHandler, 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, getPointStyleHandler, getSpanGapHandler, getTension, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderCapStyle, setBorderCapStyle, setBorderCapStyle, setBorderColor, setBorderColor, setBorderColor, setBorderDash, setBorderDash, setBorderDash, setBorderDashOffset, setBorderDashOffset, setBorderDashOffset, setBorderJoinStyle, setBorderJoinStyle, setBorderJoinStyle, setBorderWidth, setBorderWidth, setBorderWidth, setFill, setFill, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderCapStyle, setHoverBorderCapStyle, setHoverBorderCapStyle, setHoverBorderColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderDash, setHoverBorderDash, setHoverBorderDash, setHoverBorderDashOffset, setHoverBorderDashOffset, setHoverBorderDashOffset, setHoverBorderJoinStyle, setHoverBorderJoinStyle, setHoverBorderJoinStyle, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setPointBackgroundColor, setPointBackgroundColor, setPointBackgroundColor, setPointBackgroundColor, setPointBackgroundColor, setPointBorderColor, setPointBorderColor, setPointBorderColor, setPointBorderColor, setPointBorderColor, setPointBorderWidth, setPointBorderWidth, setPointBorderWidth, setPointHitRadius, setPointHitRadius, setPointHitRadius, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBackgroundColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderColor, setPointHoverBorderWidth, setPointHoverBorderWidth, setPointHoverBorderWidth, setPointHoverRadius, setPointHoverRadius, setPointHoverRadius, setPointRadius, setPointRadius, setPointRadius, setPointRotation, setPointRotation, setPointRotation, setTension

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

createContext, getAnimationContainer, getBackgroundColorCallback, getBorderColorCallback, getClip, getClipAsObject, getData, getData, getDataCount, getDataset, getDataType, getDefaultValues, getHoverBackgroundColorCallback, getHoverBorderColorCallback, getId, getOptions, getOptions, getScope, getType, getTypedDataset, hasOptions, invokeColorCallback, isClip, isHidden, isNormalized, isParsing, removeOptions, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setClip, setClip, setClip, setData, setData, setHidden, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setLabel, setNormalized, setOptions, setOptions, setParsing

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

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

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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.options.HasFill

setFill, setFill, setFill, setFill

Methods inherited from interface org.pepstock.charba.client.options.HasSpanGaps

getSpanGaps, isSpanGaps, setSpanGaps, setSpanGaps

Methods inherited from interface org.pepstock.charba.client.options.HasAnimationOptions

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

Methods inherited from interface org.pepstock.charba.client.commons.HasCallbackScope

extractScope

Constructor Detail

VerticalLineDataset

public VerticalLineDataset()

Creates a data set.
It uses the global options has default.

VerticalLineDataset

public VerticalLineDataset(boolean hidden)

Creates a data set.
It uses the global options has default.

Parameters:

hidden - if true, it will be initially hidden.

VerticalLineDataset

public VerticalLineDataset(IsDefaultOptions defaultValues)

Creates the data set using a default.

Parameters:

defaultValues - default options

VerticalLineDataset

public VerticalLineDataset(IsDefaultOptions defaultValues,
                           boolean hidden)

Creates the data set using a default.

Parameters:

defaultValues - default options

hidden - if true, it will be initially hidden.

VerticalLineDataset

protected VerticalLineDataset(Type type,
                              boolean hidden)

Creates the data set using chart type related to the data set.

Parameters:

type - chart type related to the data set

hidden - if true, it will be initially hidden.

VerticalLineDataset

protected VerticalLineDataset(Type type,
                              IsDefaultOptions defaultValues,
                              boolean hidden)

Creates the data set using a default and chart type related to the data set.

Parameters:

type - chart type related to the data set

defaultValues - default options

hidden - if true, it will be initially hidden.

Method Detail

setIndexAxis

public void setIndexAxis(IndexAxis indexAxis)

Description copied from class: LineDataset

Sets the base axis for the data set. Use IndexAxis.Y for vertical line.

Overrides:

setIndexAxis in class LineDataset

Parameters:

indexAxis - the base axis for the data set

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

setPointStyle

public void setPointStyle(PointStyle... pointStyle)

Sets the style of the point.

Parameters:

pointStyle - array of the style of the point.

getPointStyle

public List<PointStyle> getPointStyle()

Returns the style of the point.

Returns:

the style of the point or null if point style is set as image

setPointStyle

public void setPointStyle(Img... pointStyle)

Sets the style of the point as image.

Parameters:

pointStyle - image element of the style of the point as image.

getPointStyleType

public PointStyleType getPointStyleType()

Returns the type of point style.

Returns:

the type of point style

getPointStyleAsImages

public List<Img> getPointStyleAsImages()

Returns the style of the point as image.
If property is missing or not an image, returns null.

Returns:

image of the style of the point as image.
If property is missing or not a image, returns null.

setPointStyle

public void setPointStyle(Canvas... pointStyle)

Sets the style of the point as canvas.

Parameters:

pointStyle - canvas element of the style of the point as canvas.

getPointStyleAsCanvas

public List<Canvas> getPointStyleAsCanvas()

Returns the style of the point as canvas.
If property is missing or not an canvas, returns null.

Returns:

image of the style of the point as canvas.
If property is missing or not a canvas, returns null.

getPointStyleCallback

public PointStyleCallback getPointStyleCallback()

Returns the point style callback, if set, otherwise null.

Returns:

the point style callback, if set, otherwise null.

setPointStyle

public void setPointStyle(PointStyleCallback pointStyleCallback)

Sets the point style callback.

Parameters:

pointStyleCallback - the point style callback.