Package org.pepstock.charba.client.data

Class ScatterDataset

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.ScatterDataset

All Implemented Interfaces:

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

public final class ScatterDataset
extends LineDataset

The scatter chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.
Extends the line dataset to set fixed properties for scatter chart.
The scatter dataset can use ONLY data points. If you try to use array of data numbers, an exception will be thrown.

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	Description
	ScatterDataset()	Creates a dataset. It uses the global options has default.
	ScatterDataset(boolean hidden)	Creates a dataset. It uses the global options has default.
	ScatterDataset(IsDefaultOptions defaultValues)	Creates the dataset using a default.
	ScatterDataset(IsDefaultOptions defaultValues, boolean hidden)	Creates the dataset using a default.
protected	ScatterDataset(Type type, boolean hidden)	Creates the dataset using chart type related to the dataset.
protected	ScatterDataset(Type type, IsDefaultOptions defaultValues, boolean hidden)	Creates the dataset using a default and chart type related to the dataset.

Method Summary

Modifier and Type	Method	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<DatasetContext>	getPointStyleCallback()	Returns the point style callback, if set, otherwise null.
default PointStyleType	getPointStyleType()	Returns the type of point style.
void	setFill(FillCallback fillCallback)	Sets the fill callback.
void	setFill(NativeCallback fillCallback)	Sets the fill callback.
void	setFill(IsFill fill)	Sets how to fill the area under the line.
void	setFillBaseline(double baseline)	Sets the baseline value to use for filling.
default void	setOrder(int order)	Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
default void	setPointStyle(PointStyleCallback<DatasetContext> pointStyleCallback)	Sets the point style callback.
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.

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, setIndexAxis, 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, getDrawActiveElementsOnTopCallback, 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, isDrawActiveElementsOnTop, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderCapStyle, setBorderCapStyle, setBorderCapStyle, setBorderColor, setBorderColor, setBorderColor, setBorderDash, setBorderDash, setBorderDash, setBorderDashOffset, setBorderDashOffset, setBorderDashOffset, setBorderJoinStyle, setBorderJoinStyle, setBorderJoinStyle, setBorderWidth, setBorderWidth, setBorderWidth, setDrawActiveElementsOnTop, setDrawActiveElementsOnTop, setDrawActiveElementsOnTop, 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, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, 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

checkAndGetColor, 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, 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, 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.options.HasAnimationOptions

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

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

getFill, getFillBaseline, getFillColors, setFill, setFill, setFill, setFillBaseline, setFillColors

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

getSpanGaps, isSpanGaps, setSpanGaps, setSpanGaps

Constructor Detail

ScatterDataset

public ScatterDataset()

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

ScatterDataset

public ScatterDataset(boolean hidden)

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

Parameters:

hidden - if true, it will be initially hidden.

ScatterDataset

public ScatterDataset(IsDefaultOptions defaultValues)

Creates the dataset using a default.

Parameters:

defaultValues - default options

ScatterDataset

public ScatterDataset(IsDefaultOptions defaultValues,
                      boolean hidden)

Creates the dataset using a default.

Parameters:

defaultValues - default options

hidden - if true, it will be initially hidden.

ScatterDataset

protected ScatterDataset(Type type,
                         boolean hidden)

Creates the dataset using chart type related to the dataset.

Parameters:

type - chart type related to the dataset

hidden - if true, it will be initially hidden.

ScatterDataset

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

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

Parameters:

type - chart type related to the dataset

defaultValues - default options

hidden - if true, it will be initially hidden.

Method Detail

setFill

public void setFill(IsFill fill)

Description copied from interface: HasFill

Sets how to fill the area under the line.

Parameters:

fill - how to fill the area under the line.

setFillBaseline

public void setFillBaseline(double baseline)

Description copied from interface: HasFill

Sets the baseline value to use for filling.

Parameters:

baseline - the baseline value to use for filling

setFill

public void setFill(FillCallback fillCallback)

Description copied from class: LiningDataset

Sets the fill callback.

Overrides:

setFill in class LiningDataset

Parameters:

fillCallback - the fill callback.

setFill

public void setFill(NativeCallback fillCallback)

Description copied from class: LiningDataset

Sets the fill callback.

Overrides:

setFill in class LiningDataset

Parameters:

fillCallback - the fill callback.

setOrder

public default 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 default int getOrder()

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

Returns:

the drawing order of dataset

setPointStyle

public default void setPointStyle(PointStyle... pointStyle)

Sets the style of the point.

Parameters:

pointStyle - array of the style of the point.

getPointStyle

public default 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 default 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 default PointStyleType getPointStyleType()

Returns the type of point style.

Returns:

the type of point style

getPointStyleAsImages

public default 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 default 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 default 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 default PointStyleCallback<DatasetContext> getPointStyleCallback()

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

Returns:

the point style callback, if set, otherwise null.

setPointStyle

public default void setPointStyle(PointStyleCallback<DatasetContext> pointStyleCallback)

Sets the point style callback.

Parameters:

pointStyleCallback - the point style callback.