org.pepstock.charba.client.defaults.chart

Class DefaultChartGridLines

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartGridLines

All Implemented Interfaces:

IsDefaultGridLines

public final class DefaultChartGridLines
extends Object
implements IsDefaultGridLines

Defaults for grid lines option element, based on chart type.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
int	getBorderDashOffset() Returns the line dash pattern offset or "phase".
String	getColorAsString() The color of the grid lines.
int	getLineWidth() Returns the stroke widths of grid lines.
int	getTickMarkLength() Returns the length in pixels that the grid lines will draw into the axis area.
int	getZeroLineBorderDashOffset() Returns the offset for line dashes of the grid line for the first index (index 0).
String	getZeroLineColorAsString() Returns the stroke color of the grid line for the first index (index 0).
int	getZeroLineWidth() Returns the stroke width of the grid line for the first index (index 0).
boolean	isCircular() If true, gridlines are circular (on radar chart only).
boolean	isDisplay() If false, do not display grid lines for this axis.
boolean	isDrawBorder() If true, draw border at the edge between the axis and the chart area.
boolean	isDrawOnChartArea() If true, draw lines on the chart area inside the axis lines.
boolean	isDrawTicks() If true, draw lines beside the ticks in the axis area beside the chart.
boolean	isOffsetGridLines() If true, grid lines will be shifted to be between labels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isDisplay

public boolean isDisplay()

Description copied from interface: IsDefaultGridLines

If false, do not display grid lines for this axis.

Specified by:

isDisplay in interface IsDefaultGridLines

Returns:

If false, do not display grid lines for this axis.

getColorAsString

public String getColorAsString()

Description copied from interface: IsDefaultGridLines

The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.

Specified by:

getColorAsString in interface IsDefaultGridLines

Returns:

the list of colors of the grid lines.

getBorderDashOffset

public int getBorderDashOffset()

Description copied from interface: IsDefaultGridLines

Returns the line dash pattern offset or "phase".

Specified by:

getBorderDashOffset in interface IsDefaultGridLines

Returns:

Offset for line dashes.

getLineWidth

public int getLineWidth()

Description copied from interface: IsDefaultGridLines

Returns the stroke widths of grid lines.

Specified by:

getLineWidth in interface IsDefaultGridLines

Returns:

lineWidth stroke widths of grid lines.

isDrawBorder

public boolean isDrawBorder()

Description copied from interface: IsDefaultGridLines

If true, draw border at the edge between the axis and the chart area.

Specified by:

isDrawBorder in interface IsDefaultGridLines

Returns:

If true, draw border at the edge between the axis and the chart area.

isDrawOnChartArea

public boolean isDrawOnChartArea()

Description copied from interface: IsDefaultGridLines

If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.

Specified by:

isDrawOnChartArea in interface IsDefaultGridLines

Returns:

If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.

isDrawTicks

public boolean isDrawTicks()

Description copied from interface: IsDefaultGridLines

If true, draw lines beside the ticks in the axis area beside the chart.

Specified by:

isDrawTicks in interface IsDefaultGridLines

Returns:

If true, draw lines beside the ticks in the axis area beside the chart.

getTickMarkLength

public int getTickMarkLength()

Description copied from interface: IsDefaultGridLines

Returns the length in pixels that the grid lines will draw into the axis area.

Specified by:

getTickMarkLength in interface IsDefaultGridLines

Returns:

Length in pixels that the grid lines will draw into the axis area.

getZeroLineWidth

public int getZeroLineWidth()

Description copied from interface: IsDefaultGridLines

Returns the stroke width of the grid line for the first index (index 0).

Specified by:

getZeroLineWidth in interface IsDefaultGridLines

Returns:

Stroke width of the grid line for the first index (index 0).

getZeroLineColorAsString

public String getZeroLineColorAsString()

Description copied from interface: IsDefaultGridLines

Returns the stroke color of the grid line for the first index (index 0).

Specified by:

getZeroLineColorAsString in interface IsDefaultGridLines

Returns:

Stroke color of the grid line for the first index (index 0).

getZeroLineBorderDashOffset

public int getZeroLineBorderDashOffset()

Description copied from interface: IsDefaultGridLines

Returns the offset for line dashes of the grid line for the first index (index 0).

Specified by:

getZeroLineBorderDashOffset in interface IsDefaultGridLines

Returns:

the offset for line dashes of the grid line for the first index (index 0).

isOffsetGridLines

public boolean isOffsetGridLines()

Description copied from interface: IsDefaultGridLines

If true, grid lines will be shifted to be between labels. This is set to true in the bar chart by default.

Specified by:

isOffsetGridLines in interface IsDefaultGridLines

Returns:

If true, grid lines will be shifted to be between labels.

isCircular

public boolean isCircular()

Description copied from interface: IsDefaultGridLines

If true, gridlines are circular (on radar chart only).

Specified by:

isCircular in interface IsDefaultGridLines

Returns:

If true, gridlines are circular (on radar chart only).