Class TreeMapElementOptions
- java.lang.Object
-
- org.pepstock.charba.client.commons.NativeObjectContainer
-
- org.pepstock.charba.client.commons.AbstractNode
-
- org.pepstock.charba.client.items.ChartElementOptions
-
- org.pepstock.charba.client.items.CommonElementOptions
-
- org.pepstock.charba.client.treemap.TreeMapElementOptions
-
public final class TreeMapElementOptions extends CommonElementOptions
Maps the out-of-the-box CHART.JS element options used to represents boxes for treemap on the charts.- Author:
- Andrea "Stock" Stocchero
-
-
Field Summary
Fields Modifier and Type Field Description static ElementFactory<TreeMapElementOptions>
FACTORY
Element factory to get ""treemap"" element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getBorderRadius()
Returns the border radius (in pixels).BarBorderRadius
getBorderRadiusAsObject()
Returns the border radius (in pixels).int
getBorderWidth()
Returns the border width of the dataset item in pixels.BarBorderWidth
getBorderWidthAsObject()
Returns the border width of the dataset item in pixels asBarBorderWidth
.Captions
getCaptions()
Returns the captions object.protected int
getDefaultBorderWidth()
This method must be overrided by all element where the border width is stored in different object.Dividers
getDividers()
Returns the dividers object.Labels
getLabels()
Returns the labels object.double
getSpacing()
Returns the fixed spacing among rectangles.boolean
isBorderWidthAsObject()
Returnstrue
if the border width is defined asBarBorderWidth
.boolean
isRtl()
Returnstrue
for rendering the rectangles from right to left.void
setBorderRadius(int radius)
Sets the border radius.void
setBorderRadius(BarBorderRadius borderRadius)
Sets the border radius (in pixels).void
setBorderWidth(BarBorderWidth borderWidth)
Sets the border width (in pixels).void
setRtl(boolean rtl)
Setstrue
for rendering the rectangles from right to left.void
setSpacing(double spacing)
Sets the fixed spacing among rectangles.-
Methods inherited from class org.pepstock.charba.client.items.CommonElementOptions
createTooltipLabelColor, getBackgroundColor, getBackgroundColorAsCanvasGradient, getBackgroundColorAsCanvasPattern, getBackgroundColorAsGradient, getBackgroundColorAsPattern, getBackgroundColorAsString, getBorderColor, getBorderColorAsCanvasGradient, getBorderColorAsGradient, getBorderColorAsString, inRange, inXRange, inYRange, isBackgroundColorAsColor, isBackgroundColorAsGradient, isBackgroundColorAsPattern, isBorderColorAsColor, isBorderColorAsGradient, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth
-
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
-
-
-
-
Field Detail
-
FACTORY
public static final ElementFactory<TreeMapElementOptions> FACTORY
Element factory to get ""treemap"" element.
-
-
Method Detail
-
getDividers
public Dividers getDividers()
Returns the dividers object.- Returns:
- the dividers object.
-
getCaptions
public Captions getCaptions()
Returns the captions object.- Returns:
- the captions object.
-
getLabels
public Labels getLabels()
Returns the labels object.- Returns:
- the labels object.
-
getDefaultBorderWidth
protected int getDefaultBorderWidth()
Description copied from class:CommonElementOptions
This method must be overrided by all element where the border width is stored in different object.- Overrides:
getDefaultBorderWidth
in classCommonElementOptions
- Returns:
- an undefined integer
-
getBorderWidth
public int getBorderWidth()
Returns the border width of the dataset item in pixels.- Overrides:
getBorderWidth
in classCommonElementOptions
- Returns:
- the border width of the dataset item in pixels.
-
isBorderWidthAsObject
public boolean isBorderWidthAsObject()
Returnstrue
if the border width is defined asBarBorderWidth
.- Returns:
true
if the border width is defined asBarBorderWidth
-
getBorderWidthAsObject
public BarBorderWidth getBorderWidthAsObject()
Returns the border width of the dataset item in pixels asBarBorderWidth
.- Returns:
- the border width of the dataset item in pixels as
BarBorderWidth
.
-
setBorderWidth
public void setBorderWidth(BarBorderWidth borderWidth)
Sets the border width (in pixels).- Parameters:
borderWidth
- the border width (in pixels).
-
setRtl
public void setRtl(boolean rtl)
Setstrue
for rendering the rectangles from right to left.- Parameters:
rtl
-true
for rendering the rectangles from right to left
-
isRtl
public boolean isRtl()
Returnstrue
for rendering the rectangles from right to left.- Returns:
true
for rendering the rectangles from right to left.
-
setSpacing
public void setSpacing(double spacing)
Sets the fixed spacing among rectangles.- Parameters:
spacing
- the fixed spacing among rectangles
-
getSpacing
public double getSpacing()
Returns the fixed spacing among rectangles.- Returns:
- the fixed spacing among rectangles
-
getBorderRadiusAsObject
public BarBorderRadius getBorderRadiusAsObject()
Returns the border radius (in pixels).- Returns:
- the border radius (in pixels).
-
setBorderRadius
public void setBorderRadius(BarBorderRadius borderRadius)
Sets the border radius (in pixels).- Parameters:
borderRadius
- the border radius (in pixels).
-
setBorderRadius
public void setBorderRadius(int radius)
Sets the border radius.- Parameters:
radius
- the border radius.
-
getBorderRadius
public int getBorderRadius()
Returns the border radius (in pixels).- Returns:
- the border radius (in pixels).
-
-