Class DefaultChartArc
- java.lang.Object
-
- org.pepstock.charba.client.defaults.chart.DefaultChartArc
-
- All Implemented Interfaces:
IsDefaultArc,IsDefaultOptionsElement
public final class DefaultChartArc extends Object implements IsDefaultArc
Defaults for arc option element, based on chart type.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description doublegetAngle()Returns the arc angle to cover.StringgetBackgroundColorAsString()Returns the background color.BorderAligngetBorderAlign()Returns the property to set the border alignment on chart datasets.StringgetBorderColorAsString()Returns the border color.JoinStylegetBorderJoinStyle()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).intgetBorderRadius()Returns the arc border radius (in pixels).intgetBorderWidth()Returns the border width.StringgetHoverBackgroundColorAsString()Returns the background color when hovered.StringgetHoverBorderColorAsString()Returns the border color when hovered.JoinStylegetHoverBorderJoinStyle()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 hovered.intgetHoverBorderWidth()Returns the border width when hovered.intgetHoverOffset()Returns the arc offset (in pixels) when hovered.intgetOffset()Returns the arc offset (in pixels).intgetSpacing()Returns the fixed arc offset (in pixels).
Similar tooffsetbut applies to all arcs.doublegetWeight()Returns the relative thickness of the dataset.
Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.booleanisCircular()Returnstrueif the arc is curved.
-
-
-
Method Detail
-
getBackgroundColorAsString
public String getBackgroundColorAsString()
Description copied from interface:IsDefaultOptionsElementReturns the background color.- Specified by:
getBackgroundColorAsStringin interfaceIsDefaultOptionsElement- Returns:
- the background color.
-
getBorderWidth
public int getBorderWidth()
Description copied from interface:IsDefaultOptionsElementReturns the border width.- Specified by:
getBorderWidthin interfaceIsDefaultOptionsElement- Returns:
- the border width.
-
getBorderColorAsString
public String getBorderColorAsString()
Description copied from interface:IsDefaultOptionsElementReturns the border color.- Specified by:
getBorderColorAsStringin interfaceIsDefaultOptionsElement- Returns:
- the border color.
-
getBorderAlign
public BorderAlign getBorderAlign()
Description copied from interface:IsDefaultArcReturns the property to set the border alignment on chart datasets.- Specified by:
getBorderAlignin interfaceIsDefaultArc- Returns:
- the property to set the border alignment on chart datasets.
-
getBorderJoinStyle
public JoinStyle getBorderJoinStyle()
Description copied from interface:IsDefaultArcReturns 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).- Specified by:
getBorderJoinStylein interfaceIsDefaultArc- Returns:
- how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together
-
getWeight
public double getWeight()
Description copied from interface:IsDefaultArcReturns the relative thickness of the dataset.
Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.- Specified by:
getWeightin interfaceIsDefaultArc- Returns:
- the relative thickness of the dataset
-
getAngle
public double getAngle()
Description copied from interface:IsDefaultArcReturns the arc angle to cover.- Specified by:
getAnglein interfaceIsDefaultArc- Returns:
- the arc angle to cover
-
getOffset
public int getOffset()
Description copied from interface:IsDefaultArcReturns the arc offset (in pixels).- Specified by:
getOffsetin interfaceIsDefaultArc- Returns:
- the arc offset
-
getBorderRadius
public int getBorderRadius()
Description copied from interface:IsDefaultArcReturns the arc border radius (in pixels).- Specified by:
getBorderRadiusin interfaceIsDefaultArc- Returns:
- the arc border radius (in pixels).
-
getHoverBackgroundColorAsString
public String getHoverBackgroundColorAsString()
Description copied from interface:IsDefaultOptionsElementReturns the background color when hovered.- Specified by:
getHoverBackgroundColorAsStringin interfaceIsDefaultOptionsElement- Returns:
- the background color when hovered.
-
getHoverBorderWidth
public int getHoverBorderWidth()
Description copied from interface:IsDefaultOptionsElementReturns the border width when hovered.- Specified by:
getHoverBorderWidthin interfaceIsDefaultOptionsElement- Returns:
- the border width when hovered.
-
getHoverBorderColorAsString
public String getHoverBorderColorAsString()
Description copied from interface:IsDefaultOptionsElementReturns the border color when hovered.- Specified by:
getHoverBorderColorAsStringin interfaceIsDefaultOptionsElement- Returns:
- the border color when hovered.
-
getHoverOffset
public int getHoverOffset()
Description copied from interface:IsDefaultArcReturns the arc offset (in pixels) when hovered.- Specified by:
getHoverOffsetin interfaceIsDefaultArc- Returns:
- the arc offset when hovered
-
getSpacing
public int getSpacing()
Description copied from interface:IsDefaultArcReturns the fixed arc offset (in pixels).
Similar tooffsetbut applies to all arcs.- Specified by:
getSpacingin interfaceIsDefaultArc- Returns:
- the fixed arc offset (in pixels)
-
getHoverBorderJoinStyle
public JoinStyle getHoverBorderJoinStyle()
Description copied from interface:IsDefaultArcReturns 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 hovered.- Specified by:
getHoverBorderJoinStylein interfaceIsDefaultArc- Returns:
- how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are joined together
-
isCircular
public boolean isCircular()
Description copied from interface:IsDefaultArcReturnstrueif the arc is curved.- Specified by:
isCircularin interfaceIsDefaultArc- Returns:
trueif the arc is curved
-
-