org.pepstock.charba.client.defaults.chart

Class DefaultChartGrid

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartGrid

All Implemented Interfaces:

IsDefaultGrid, IsDefaultScaleLines

public final class DefaultChartGrid
extends Object
implements IsDefaultGrid

Defaults for grid option element, based on chart type.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
String	getBorderColorAsString() If set, used as the color of the border line. If unset, the first color option is resolved and used.
List<Integer>	getBorderDash() 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	getBorderDashOffset() Returns the line dash pattern offset.
int	getBorderWidth() If set, used as the width of the border line. If unset, the first lineWidth option is resolved and used.
String	getColorAsString() Returns the color of lines.
int	getLineWidth() Returns the width of lines.
double	getTickBorderDashOffset() Returns the offset for the line dash of the tick mark.
String	getTickColorAsString() Returns the color of the tick line.
int	getTickLength() Returns the length in pixels that the grid will draw in the the axis area.
int	getTickWidth() Returns the width of the tick mark in pixels. The first element if set as array.
int	getZ() Returns z-index of grid layer. Values less than or equals to 0 are drawn under data sets, greater than 0 on top.
boolean	isCircular() If true, grid are circular (on radar chart only).
boolean	isDisplay() If false, do not display grid 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. This is useful when there are multiple axes and you need to control which grid are drawn.
boolean	isDrawTicks() If true, draw lines beside the ticks in the axis area beside the chart.
boolean	isOffset() If true, grid 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: IsDefaultGrid

If false, do not display grid for this axis.

Specified by:

isDisplay in interface IsDefaultGrid

Returns:

if false, do not display grid for this axis.

getColorAsString

public String getColorAsString()

Description copied from interface: IsDefaultScaleLines

Returns the color of lines.

Specified by:

getColorAsString in interface IsDefaultScaleLines

Returns:

color of lines.

getBorderDashOffset

public double getBorderDashOffset()

Description copied from interface: IsDefaultScaleLines

Returns the line dash pattern offset.

Specified by:

getBorderDashOffset in interface IsDefaultScaleLines

Returns:

Offset for line dashes.

getBorderWidth

public int getBorderWidth()

Description copied from interface: IsDefaultGrid

If set, used as the width of the border line.
If unset, the first lineWidth option is resolved and used.

Specified by:

getBorderWidth in interface IsDefaultGrid

Returns:

if set, used as the width of the border line.
If unset, the first lineWidth option is resolved and used.

getBorderColorAsString

public String getBorderColorAsString()

Description copied from interface: IsDefaultGrid

If set, used as the color of the border line.
If unset, the first color option is resolved and used.

Specified by:

getBorderColorAsString in interface IsDefaultGrid

Returns:

if set, used as the color of the border line.
If unset, the first color option is resolved and used.

getLineWidth

public int getLineWidth()

Description copied from interface: IsDefaultScaleLines

Returns the width of lines.

Specified by:

getLineWidth in interface IsDefaultScaleLines

Returns:

width of lines.

isDrawBorder

public boolean isDrawBorder()

Description copied from interface: IsDefaultGrid

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

Specified by:

isDrawBorder in interface IsDefaultGrid

Returns:

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

isDrawOnChartArea

public boolean isDrawOnChartArea()

Description copied from interface: IsDefaultGrid

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 are drawn.

Specified by:

isDrawOnChartArea in interface IsDefaultGrid

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 are drawn.

isDrawTicks

public boolean isDrawTicks()

Description copied from interface: IsDefaultGrid

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

Specified by:

isDrawTicks in interface IsDefaultGrid

Returns:

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

getTickLength

public int getTickLength()

Description copied from interface: IsDefaultGrid

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

Specified by:

getTickLength in interface IsDefaultGrid

Returns:

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

isOffset

public boolean isOffset()

Description copied from interface: IsDefaultGrid

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

Specified by:

isOffset in interface IsDefaultGrid

Returns:

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

isCircular

public boolean isCircular()

Description copied from interface: IsDefaultGrid

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

Specified by:

isCircular in interface IsDefaultGrid

Returns:

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

getZ

public int getZ()

Description copied from interface: IsDefaultGrid

Returns z-index of grid layer.
Values less than or equals to 0 are drawn under data sets, greater than 0 on top.

Specified by:

getZ in interface IsDefaultGrid

Returns:

z-index of grid layer.
Values less than or equals to 0 are drawn under data sets, greater than 0 on top.

getTickBorderDashOffset

public double getTickBorderDashOffset()

Description copied from interface: IsDefaultGrid

Returns the offset for the line dash of the tick mark.

Specified by:

getTickBorderDashOffset in interface IsDefaultGrid

Returns:

the offset for the line dash of the tick mark

getTickColorAsString

public String getTickColorAsString()

Description copied from interface: IsDefaultGrid

Returns the color of the tick line.

Specified by:

getTickColorAsString in interface IsDefaultGrid

Returns:

the color of the tick line.

getTickWidth

public int getTickWidth()

Description copied from interface: IsDefaultGrid

Returns the width of the tick mark in pixels.
The first element if set as array.

Specified by:

getTickWidth in interface IsDefaultGrid

Returns:

stroke width of grid.
The first element if set as array.

getBorderDash

public List<Integer> getBorderDash()

Description copied from interface: IsDefaultScaleLines

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.

Specified by:

getBorderDash in interface IsDefaultScaleLines

Returns:

the line dash pattern used when stroking lines