Package org.pepstock.charba.client.data

Class PolarAreaDataset

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

org.pepstock.charba.client.data.HoverDataset

org.pepstock.charba.client.data.PolarAreaDataset

All Implemented Interfaces:

HasCallbackScope, HasDataset, IsDefaultAnimationContainer, IsDefaultAnimationTransition, HasAnimationOptions

public class PolarAreaDataset
extends HoverDataset

The polar area chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.

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
	PolarAreaDataset()	Creates a dataset. It uses the global options has default.
	PolarAreaDataset(boolean hidden)	Creates a dataset. It uses the global options has default.
	PolarAreaDataset(IsDefaultOptions defaultValues)	Creates the dataset using a default.
	PolarAreaDataset(IsDefaultOptions defaultValues, boolean hidden)	Creates the dataset using a default.
protected	PolarAreaDataset(Type type, boolean hidden)	Creates the dataset using chart type related to the dataset.
protected	PolarAreaDataset(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 List<BorderAlign>	getBorderAlign()	Returns the property to set the border alignment on chart datasets.
default BorderAlignCallback	getBorderAlignCallback()	Returns the border align callback, if set, otherwise null.
org.pepstock.charba.client.data.BorderAlignHandler	getBorderAlignHandler()
List<JoinStyle>	getBorderJoinStyle()	Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).
JoinStyleCallback<DatasetContext>	getBorderJoinStyleCallback()	Returns the border join style callback, if set, otherwise null.
CircularCallback	getCircularCallback()	Returns true if the arc is curved.
List<JoinStyle>	getHoverBorderJoinStyle()	Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped), when element is hovered. There are three possible values for this property: round, bevel and miter.
JoinStyleCallback<DatasetContext>	getHoverBorderJoinStyleCallback()	Returns the border join style callback when element is hovered, if set, otherwise null.
boolean	isCircular()	Returns true if the arc is curved.
default void	setBorderAlign(List<BorderAlign> align)	Sets the property to set the border alignment on chart datasets.
default void	setBorderAlign(BorderAlignCallback borderAlignCallback)	Sets the border align callback.
default void	setBorderAlign(NativeCallback borderAlignCallback)	Sets the border align callback.
default void	setBorderAlign(BorderAlign... align)	Sets the property to set the border alignment on chart datasets.
void	setBorderJoinStyle(JoinStyleCallback<DatasetContext> borderJoinStyleCallback)	Sets the border join style callback.
void	setBorderJoinStyle(NativeCallback borderJoinStyleCallback)	Sets the border join style callback.
void	setBorderJoinStyle(JoinStyle... borderJoinStyle)	Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).
void	setCircular(int circular)	Sets true if the arc is curved.
void	setCircular(CircularCallback circularCallback)	Sets true if the arc is curved
void	setCircular(NativeCallback circularCallback)	Sets true if the arc is curved
void	setHoverBorderJoinStyle(JoinStyleCallback<DatasetContext> borderJoinStyleCallback)	Sets the border join style callback when element is hovered.
void	setHoverBorderJoinStyle(NativeCallback borderJoinStyleCallback)	Sets the border join style callback when element is hovered.
void	setHoverBorderJoinStyle(JoinStyle... borderJoinStyle)	Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped), when element is hovered. There are three possible values for this property: round, bevel and miter.

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

getBorderWidthCallback, getColors, getHoverBackgroundColorAsGradient, getHoverBackgroundColorAsPatterns, getHoverBackgroundColorAsString, getHoverBorderColorAsGradient, getHoverBorderColorAsString, getHoverBorderWidthCallback, getWidths, setBorderWidth, setBorderWidth, setColors, setColors, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderWidth, setWidths

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

getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPatterns, getBackgroundColorAsString, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getBorderWidth, getHoverBackgroundColor, getHoverBorderColor, getHoverBorderWidth, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth, setHoverBorderWidth

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

createContext, getAnimationContainer, getBackgroundColorCallback, getBorderColorCallback, getClip, getClipAsObject, getData, getData, getDataCount, getDataset, getDataType, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultHoverBackgroundColorAsString, getDefaultHoverBorderColorAsString, getDefaultHoverBorderWidth, getDefaultValues, getHoverBackgroundColorCallback, getHoverBorderColorCallback, getId, getLabel, 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

Constructor Detail

PolarAreaDataset

public PolarAreaDataset()

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

PolarAreaDataset

public PolarAreaDataset(boolean hidden)

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

Parameters:

hidden - if true, it will be initially hidden.

PolarAreaDataset

public PolarAreaDataset(IsDefaultOptions defaultValues)

Creates the dataset using a default.

Parameters:

defaultValues - default options

PolarAreaDataset

public PolarAreaDataset(IsDefaultOptions defaultValues,
                        boolean hidden)

Creates the dataset using a default.

Parameters:

defaultValues - default options

hidden - if true, it will be initially hidden.

PolarAreaDataset

protected PolarAreaDataset(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.

PolarAreaDataset

protected PolarAreaDataset(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

getBorderAlignHandler

public final org.pepstock.charba.client.data.BorderAlignHandler getBorderAlignHandler()

setHoverBorderJoinStyle

public void setHoverBorderJoinStyle(JoinStyle... borderJoinStyle)

Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped), when element is hovered.
There are three possible values for this property: round, bevel and miter. By default this property is set to miter.

Parameters:

borderJoinStyle - There are three possible values for this property: round, bevel and miter.

getHoverBorderJoinStyle

public List<JoinStyle> getHoverBorderJoinStyle()

Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped), when element is hovered.
There are three possible values for this property: round, bevel and miter. By default this property is set to miter.

Returns:

There are three possible values for this property: round, bevel and miter.

setBorderJoinStyle

public void setBorderJoinStyle(JoinStyle... borderJoinStyle)

Sets how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).

Parameters:

borderJoinStyle - how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together

getBorderJoinStyle

public List<JoinStyle> getBorderJoinStyle()

Returns how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together (degenerate segments with zero lengths, whose specified end points and control points are exactly at the same position, are skipped).

Returns:

how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together

setCircular

public void setCircular(int circular)

Sets true if the arc is curved.

Parameters:

circular - true if the arc is curved

isCircular

public boolean isCircular()

Returns true if the arc is curved.

Returns:

true if the arc is curved

setBorderJoinStyle

public void setBorderJoinStyle(NativeCallback borderJoinStyleCallback)

Sets the border join style callback.

Parameters:

borderJoinStyleCallback - the border join style callback.

getBorderJoinStyleCallback

public JoinStyleCallback<DatasetContext> getBorderJoinStyleCallback()

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

Returns:

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

setBorderJoinStyle

public void setBorderJoinStyle(JoinStyleCallback<DatasetContext> borderJoinStyleCallback)

Sets the border join style callback.

Parameters:

borderJoinStyleCallback - the border join style callback.

setHoverBorderJoinStyle

public void setHoverBorderJoinStyle(NativeCallback borderJoinStyleCallback)

Sets the border join style callback when element is hovered.

Parameters:

borderJoinStyleCallback - the border join style callback when element is hovered.

getHoverBorderJoinStyleCallback

public JoinStyleCallback<DatasetContext> getHoverBorderJoinStyleCallback()

Returns the border join style callback when element is hovered, if set, otherwise null.

Returns:

the border join style callback when element is hovered, if set, otherwise null.

setHoverBorderJoinStyle

public void setHoverBorderJoinStyle(JoinStyleCallback<DatasetContext> borderJoinStyleCallback)

Sets the border join style callback when element is hovered.

Parameters:

borderJoinStyleCallback - the border join style callback when element is hovered.

setCircular

public void setCircular(NativeCallback circularCallback)

Sets true if the arc is curved

Parameters:

circularCallback - true if the arc is curved

getCircularCallback

public CircularCallback getCircularCallback()

Returns true if the arc is curved.

Returns:

true if the arc is curved.

setCircular

public void setCircular(CircularCallback circularCallback)

Sets true if the arc is curved

Parameters:

circularCallback - true if the arc is curved

setBorderAlign

public default void setBorderAlign(BorderAlign... align)

Sets the property to set the border alignment on chart datasets.

Parameters:

align - the property to set the border alignment on chart datasets

setBorderAlign

public default void setBorderAlign(List<BorderAlign> align)

Sets the property to set the border alignment on chart datasets.

Parameters:

align - the property to set the border alignment on chart datasets

getBorderAlign

public default List<BorderAlign> getBorderAlign()

Returns the property to set the border alignment on chart datasets.

Returns:

the property to set the border alignment on chart datasets.

getBorderAlignCallback

public default BorderAlignCallback getBorderAlignCallback()

Returns the border align callback, if set, otherwise null.

Returns:

the border align callback, if set, otherwise null.

setBorderAlign

public default void setBorderAlign(BorderAlignCallback borderAlignCallback)

Sets the border align callback.

Parameters:

borderAlignCallback - the border align callback to set

setBorderAlign

public default void setBorderAlign(NativeCallback borderAlignCallback)

Sets the border align callback.

Parameters:

borderAlignCallback - the border align callback to set