Class Dividers
- java.lang.Object
-
- org.pepstock.charba.client.commons.NativeObjectContainer
-
- org.pepstock.charba.client.commons.AbstractNode
-
- org.pepstock.charba.client.treemap.Dividers
-
public final class Dividers extends AbstractNode
The treemap data set allows to specify the values for displaying hierarchical data using nested rectangles.- Author:
- Andrea "Stock" Stocchero
-
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_DISPLAY
Default divider display, false.static CapStyle
DEFAULT_LINE_CAP_STYLE
Default divider capstyle,CapStyle.BUTT
static String
DEFAULT_LINE_COLOR
Default divider color,HtmlColor.BLACK
static double
DEFAULT_LINE_DASH_OFFSET
Default divider dash offset, 0.0.static int
DEFAULT_LINE_WIDTH
Default divider width, 0.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CapStyle
getLineCapStyle()
Returns how the end points of every line are drawn.IsColor
getLineColor()
Returns the divider color of the rectangle.String
getLineColorAsString()
Returns the divider color of the rectangle.List<Integer>
getLineDash()
Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.double
getLineDashOffset()
Returns the line dash pattern offset of the divider.int
getLineWidth()
Returns the width of the divider line in pixels.boolean
isDisplay()
Returnstrue
whether the element should be displayed.void
setDisplay(boolean display)
Setstrue
whether the element should be displayed.void
setLineCapStyle(CapStyle dividerCapStyle)
Sets how the end points of every line are drawn.void
setLineColor(String dividerColor)
Sets the divider color of the rectangle.void
setLineColor(IsColor dividerColor)
Sets the divider color of the rectangle.void
setLineDash(int... dividerDash)
Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.void
setLineDashOffset(double dividerDashOffset)
Sets the line dash pattern offset of the divider.void
setLineWidth(int dividerWidth)
Sets the width of the divider line in pixels.-
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, 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, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
-
-
-
-
Field Detail
-
DEFAULT_DISPLAY
public static final boolean DEFAULT_DISPLAY
Default divider display, false.- See Also:
- Constant Field Values
-
DEFAULT_LINE_CAP_STYLE
public static final CapStyle DEFAULT_LINE_CAP_STYLE
Default divider capstyle,CapStyle.BUTT
-
DEFAULT_LINE_COLOR
public static final String DEFAULT_LINE_COLOR
Default divider color,HtmlColor.BLACK
-
DEFAULT_LINE_DASH_OFFSET
public static final double DEFAULT_LINE_DASH_OFFSET
Default divider dash offset, 0.0.- See Also:
- Constant Field Values
-
DEFAULT_LINE_WIDTH
public static final int DEFAULT_LINE_WIDTH
Default divider width, 0.- See Also:
- Constant Field Values
-
-
Method Detail
-
setLineCapStyle
public void setLineCapStyle(CapStyle dividerCapStyle)
Sets how the end points of every line are drawn.- Parameters:
dividerCapStyle
- how the end points of every line are drawn.
-
getLineCapStyle
public CapStyle getLineCapStyle()
Returns how the end points of every line are drawn.- Returns:
- how the end points of every line are drawn.
-
setLineColor
public void setLineColor(IsColor dividerColor)
Sets the divider color of the rectangle.- Parameters:
dividerColor
- the divider color of the rectangle
-
setLineColor
public void setLineColor(String dividerColor)
Sets the divider color of the rectangle.- Parameters:
dividerColor
- the divider color of the rectangle
-
getLineColorAsString
public String getLineColorAsString()
Returns the divider color of the rectangle.- Returns:
- list of the divider color of the rectangle
-
getLineColor
public IsColor getLineColor()
Returns the divider color of the rectangle.- Returns:
- list of the divider color of the rectangle
-
setLineDash
public void setLineDash(int... dividerDash)
Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.- Parameters:
dividerDash
- the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
-
getLineDash
public List<Integer> getLineDash()
Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.- Returns:
- the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
-
setLineDashOffset
public void setLineDashOffset(double dividerDashOffset)
Sets the line dash pattern offset of the divider.- Parameters:
dividerDashOffset
- the line dash pattern offset of the divider
-
getLineDashOffset
public double getLineDashOffset()
Returns the line dash pattern offset of the divider.- Returns:
- the line dash pattern offset of the divider
-
setLineWidth
public void setLineWidth(int dividerWidth)
Sets the width of the divider line in pixels.- Parameters:
dividerWidth
- the width of the divider line in pixels.
-
getLineWidth
public int getLineWidth()
Returns the width of the divider line in pixels.- Returns:
- the width of the divider line in pixels.
-
setDisplay
public final void setDisplay(boolean display)
Setstrue
whether the element should be displayed.- Parameters:
display
-true
whether the element should be displayed
-
isDisplay
public final boolean isDisplay()
Returnstrue
whether the element should be displayed.- Returns:
true
whether the element should be displayed
-
-