Package software.xdev.chartjs.model.options.scales

Class GridLines

java.lang.Object

software.xdev.chartjs.model.options.scales.GridLines

public class GridLines
extends Object

The grid line configuration is nested under the scale configuration in the gridLines key. It defines options for the grid lines that run perpendicular to the axis.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Color>	color
protected Boolean	display
protected Boolean	drawBorder
protected Boolean	drawOnChartArea
protected Boolean	drawTicks
protected final List<Integer>	lineWidth
protected Boolean	offsetGridLines
protected Integer	tickMarkLength
protected Color	zeroLineColor
protected Integer	zeroLineWidth

Constructor Summary

Constructors

Constructor	Description
GridLines()

Method Summary

Modifier and Type	Method	Description
GridLines	addColor(Integer lineWidth)
GridLines	addColor(Color color)
List<Color>	getColor()
Boolean	getDisplay()
Boolean	getDrawBorder()
Boolean	getDrawOnChartArea()
Boolean	getDrawTicks()
List<Integer>	getLineWidth()
Boolean	getOffsetGridLines()
Integer	getTickMarkLength()
Color	getZeroLineColor()
Integer	getZeroLineWidth()
GridLines	setColor(List<Color> color)	Color of the grid lines.
GridLines	setDisplay(Boolean display)
GridLines	setDrawBorder(Boolean drawBorder)	If true draw border on the edge of the chart
GridLines	setDrawOnChartArea(Boolean drawOnChartArea)	If true, draw lines on the chart area inside the axis lines.
GridLines	setDrawTicks(Boolean drawTicks)	If true, draw lines beside the ticks in the axis area beside the chart.
GridLines	setLineWidth(List<Integer> lineWidth)	Stroke width of grid lines
GridLines	setOffsetGridLines(Boolean offsetGridLines)	If true, labels are shifted to be between grid lines.
GridLines	setTickMarkLength(Integer tickMarkLength)	Length in pixels that the grid lines will draw into the axis area.
GridLines	setZeroLineColor(Color zeroLineColor)	Stroke color of the grid line for the first index (index 0).
GridLines	setZeroLineWidth(Integer zeroLineWidth)	Stroke width of the grid line for the first index (index 0).

Methods inherited from class java.lang.Object

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

Field Details

color

protected final List<Color> color

lineWidth

protected final List<Integer> lineWidth

display

protected Boolean display

drawBorder

protected Boolean drawBorder

drawOnChartArea

protected Boolean drawOnChartArea

drawTicks

protected Boolean drawTicks

tickMarkLength

protected Integer tickMarkLength

zeroLineWidth

protected Integer zeroLineWidth

zeroLineColor

protected Color zeroLineColor

offsetGridLines

protected Boolean offsetGridLines

Constructor Details

GridLines

public GridLines()

Method Details

getDisplay

public Boolean getDisplay()

See Also:

• setDisplay(Boolean)

setDisplay

public GridLines setDisplay(Boolean display)

Default true

getColor

public List<Color> getColor()

See Also:

• setColor(List)

setColor

public GridLines setColor(List<Color> color)

Color of the grid lines.

Default "rgba(0, 0, 0, 0.1)"

addColor

public GridLines addColor(Color color)

See Also:

• setColor(List)

getLineWidth

public List<Integer> getLineWidth()

See Also:

• setLineWidth(List)

setLineWidth

public GridLines setLineWidth(List<Integer> lineWidth)

Stroke width of grid lines

Default 1

addColor

public GridLines addColor(Integer lineWidth)

See Also:

• setLineWidth(List)

getDrawBorder

public Boolean getDrawBorder()

See Also:

• setDrawBorder(Boolean)

setDrawBorder

public GridLines setDrawBorder(Boolean drawBorder)

If true draw border on the edge of the chart

Default true

getDrawOnChartArea

public Boolean getDrawOnChartArea()

See Also:

• setDrawOnChartArea(Boolean)

setDrawOnChartArea

public GridLines setDrawOnChartArea(Boolean drawOnChartArea)

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

Default true

getDrawTicks

public Boolean getDrawTicks()

See Also:

• setDrawTicks(Boolean)

setDrawTicks

public GridLines setDrawTicks(Boolean drawTicks)

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

Default true

getTickMarkLength

public Integer getTickMarkLength()

See Also:

• setTickMarkLength(Integer)

setTickMarkLength

public GridLines setTickMarkLength(Integer tickMarkLength)

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

Default 10

getZeroLineWidth

public Integer getZeroLineWidth()

See Also:

• setZeroLineWidth(Integer)

setZeroLineWidth

public GridLines setZeroLineWidth(Integer zeroLineWidth)

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

Default 1

getZeroLineColor

public Color getZeroLineColor()

See Also:

• setZeroLineColor(Color)

setZeroLineColor

public GridLines setZeroLineColor(Color zeroLineColor)

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

Default "rgba(0, 0, 0, 0.25)"

getOffsetGridLines

public Boolean getOffsetGridLines()

See Also:

• setOffsetGridLines(Boolean)

setOffsetGridLines

public GridLines setOffsetGridLines(Boolean offsetGridLines)

If true, labels are shifted to be between grid lines. This is used in the bar chart.

Default false