GridLines (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.JavaScriptObjectContainer
- - org.pepstock.charba.client.defaults.AbstractItem
  - - org.pepstock.charba.client.defaults.scale.GridLines

```
public final class GridLines
extends AbstractItem
```
The grid line configuration defines options for the grid lines that run perpendicular to the axis.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.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.
`int`	`getBorderDashOffset()` Returns the line dash pattern offset or "phase".
`java.util.List<IsColor>`	`getColor()` The color of the grid lines.
`java.util.List<java.lang.String>`	`getColorAsString()` The color of the grid lines.
`java.util.List<java.lang.Integer>`	`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.
`java.util.List<java.lang.Integer>`	`getZeroLineBorderDash()` Returns the length and spacing of dashes of the grid line for the first index (index 0).
`int`	`getZeroLineBorderDashOffset()` Returns the offset for line dashes of the grid line for the first index (index 0).
`IsColor`	`getZeroLineColor()` Returns the stroke color of the grid line for the first index (index 0).
`java.lang.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`	`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.
`void`	`setBorderDash(int... borderDash)` 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`	`setBorderDashOffset(int borderDashOffset)` Sets the line dash pattern offset or "phase".
`void`	`setColor(IsColor... color)` The color of the grid lines.
`void`	`setColor(java.lang.String... color)` The color of the grid lines.
`void`	`setDisplay(boolean display)` If false, do not display grid lines for this axis.
`void`	`setDrawBorder(boolean drawBorder)` If true, draw border at the edge between the axis and the chart area.
`void`	`setDrawOnChartArea(boolean drawOnChartArea)` If true, draw lines on the chart area inside the axis lines.
`void`	`setDrawTicks(boolean drawTicks)` If true, draw lines beside the ticks in the axis area beside the chart.
`void`	`setLineWidth(int... lineWidth)` Sets the stroke widths of grid lines.
`void`	`setOffsetGridLines(boolean offsetGridLines)` If true, grid lines will be shifted to be between labels.
`void`	`setTickMarkLength(int tickMarkLength)` Sets the length in pixels that the grid lines will draw into the axis area.
`void`	`setZeroLineBorderDash(int... zeroLineBorderDash)` Sets the length and spacing of dashes of the grid line for the first index (index 0).
`void`	`setZeroLineBorderDashOffset(int zeroLineBorderDashOffset)` Sets the offset for line dashes of the grid line for the first index (index 0).
`void`	`setZeroLineColor(IsColor zeroLineColor)` Sets the stroke color of the grid line for the first index (index 0).
`void`	`setZeroLineColor(java.lang.String zeroLineColor)` Sets the stroke color of the grid line for the first index (index 0).
`void`	`setZeroLineWidth(int zeroLineWidth)` Sets the stroke width of the grid line for the first index (index 0).

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem
checkAndAddToParent, hasProperty

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer
checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - setDisplay
```
public void setDisplay(boolean display)
```
    If false, do not display grid lines for this axis.
    
    Parameters:
    
    display - If false, do not display grid lines for this axis.
  - isDisplay
```
public boolean isDisplay()
```
    If false, do not display grid lines for this axis.
    
    Returns:
    
    If false, do not display grid lines for this axis. Default is true.
  - setColor
```
public void setColor(IsColor... color)
```
    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.
    
    Parameters:
    
    color - 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.
  - setColor
```
public void setColor(java.lang.String... color)
```
    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.
    
    Parameters:
    
    color - 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.
  - getColorAsString
```
public java.util.List<java.lang.String> getColorAsString()
```
    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.
    
    Returns:
    
    the list of colors of the grid lines. If not set, default is only 1 value 'rgba(0, 0, 0, 0.1)'
  - getColor
```
public java.util.List<IsColor> getColor()
```
    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.
    
    Returns:
    
    the list of colors of the grid lines. If not set, default is only 1 value 'rgba(0, 0, 0, 0.1)'
  - setBorderDash
```
public void setBorderDash(int... borderDash)
```
    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:
    
    borderDash - the line dash pattern used when stroking lines
  - getBorderDash
```
public java.util.List<java.lang.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.
    
    Returns:
    
    the line dash pattern used when stroking lines
  - setBorderDashOffset
```
public void setBorderDashOffset(int borderDashOffset)
```
    Sets the line dash pattern offset or "phase".
    
    Parameters:
    
    borderDashOffset - Offset for line dashes.
  - getBorderDashOffset
```
public int getBorderDashOffset()
```
    Returns the line dash pattern offset or "phase".
    
    Returns:
    
    Offset for line dashes. If not set, default is 0
  - setLineWidth
```
public void setLineWidth(int... lineWidth)
```
    Sets the stroke widths of grid lines.
    
    Parameters:
    
    lineWidth - stroke widths of grid lines.
  - getLineWidth
```
public java.util.List<java.lang.Integer> getLineWidth()
```
    Returns the stroke widths of grid lines.
    
    Returns:
    
    lineWidth stroke widths of grid lines. If not set, default is 1.
  - setDrawBorder
```
public void setDrawBorder(boolean drawBorder)
```
    If true, draw border at the edge between the axis and the chart area.
    
    Parameters:
    
    drawBorder - If true, draw border at the edge between the axis and the chart area.
  - isDrawBorder
```
public boolean isDrawBorder()
```
    If true, draw border at the edge between the axis and the chart area.
    
    Returns:
    
    If true, draw border at the edge between the axis and the chart area. If not set, default is true
  - setDrawOnChartArea
```
public void 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.
    
    Parameters:
    
    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.
  - isDrawOnChartArea
```
public 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 lines are drawn.
    
    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. If not set, default is true
  - setDrawTicks
```
public void setDrawTicks(boolean drawTicks)
```
    If true, draw lines beside the ticks in the axis area beside the chart.
    
    Parameters:
    
    drawTicks - If true, draw lines beside the ticks in the axis area beside the chart.
  - isDrawTicks
```
public boolean isDrawTicks()
```
    If true, draw lines beside the ticks in the axis area beside the chart.
    
    Returns:
    
    If true, draw lines beside the ticks in the axis area beside the chart. If not set, default is true
  - setTickMarkLength
```
public void setTickMarkLength(int tickMarkLength)
```
    Sets the length in pixels that the grid lines will draw into the axis area.
    
    Parameters:
    
    tickMarkLength - Length in pixels that the grid lines will draw into the axis area.
  - getTickMarkLength
```
public int getTickMarkLength()
```
    Returns the length in pixels that the grid lines will draw into the axis area.
    
    Returns:
    
    Length in pixels that the grid lines will draw into the axis area. If not set, default is 10
  - setZeroLineWidth
```
public void setZeroLineWidth(int zeroLineWidth)
```
    Sets the stroke width of the grid line for the first index (index 0).
    
    Parameters:
    
    zeroLineWidth - Stroke width of the grid line for the first index (index 0).
  - getZeroLineWidth
```
public int getZeroLineWidth()
```
    Returns the stroke width of the grid line for the first index (index 0).
    
    Returns:
    
    Stroke width of the grid line for the first index (index 0). If not set, default is 1
  - setZeroLineColor
```
public void setZeroLineColor(IsColor zeroLineColor)
```
    Sets the stroke color of the grid line for the first index (index 0).
    
    Parameters:
    
    zeroLineColor - Stroke color of the grid line for the first index (index 0).
  - setZeroLineColor
```
public void setZeroLineColor(java.lang.String zeroLineColor)
```
    Sets the stroke color of the grid line for the first index (index 0).
    
    Parameters:
    
    zeroLineColor - Stroke color of the grid line for the first index (index 0).
  - getZeroLineColorAsString
```
public java.lang.String getZeroLineColorAsString()
```
    Returns the stroke color of the grid line for the first index (index 0).
    
    Returns:
    
    Stroke color of the grid line for the first index (index 0). If not set, default is 'rgba(0, 0, 0, 0.25)'
  - getZeroLineColor
```
public IsColor getZeroLineColor()
```
    Returns the stroke color of the grid line for the first index (index 0).
    
    Returns:
    
    Stroke color of the grid line for the first index (index 0). If not set, default is 'rgba(0, 0, 0, 0.25)'
  - setZeroLineBorderDash
```
public void setZeroLineBorderDash(int... zeroLineBorderDash)
```
    Sets the length and spacing of dashes of the grid line for the first index (index 0).
    
    Parameters:
    
    zeroLineBorderDash - length and spacing of dashes of the grid line for the first index (index 0).
  - getZeroLineBorderDash
```
public java.util.List<java.lang.Integer> getZeroLineBorderDash()
```
    Returns the length and spacing of dashes of the grid line for the first index (index 0).
    
    Returns:
    
    the length and spacing of dashes of the grid line for the first index (index 0).
  - setZeroLineBorderDashOffset
```
public void setZeroLineBorderDashOffset(int zeroLineBorderDashOffset)
```
    Sets the offset for line dashes of the grid line for the first index (index 0).
    
    Parameters:
    
    zeroLineBorderDashOffset - the offset for line dashes of the grid line for the first index (index 0).
  - getZeroLineBorderDashOffset
```
public int getZeroLineBorderDashOffset()
```
    Returns the offset for line dashes of the grid line for the first index (index 0).
    
    Returns:
    
    the offset for line dashes of the grid line for the first index (index 0). if not set, default is 0
  - setOffsetGridLines
```
public void setOffsetGridLines(boolean offsetGridLines)
```
    If true, grid lines will be shifted to be between labels. This is set to true in the bar chart by default.
    
    Parameters:
    
    offsetGridLines - If true, grid lines will be shifted to be between labels.
  - isOffsetGridLines
```
public boolean isOffsetGridLines()
```
    If true, grid lines will be shifted to be between labels. This is set to true in the bar chart by default.
    
    Returns:
    
    If true, grid lines will be shifted to be between labels. If not set, default is false.

Class GridLines

Method Summary

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer

Methods inherited from class java.lang.Object

Method Detail

setDisplay

isDisplay

setColor

setColor

getColorAsString

getColor

setBorderDash

getBorderDash

setBorderDashOffset

getBorderDashOffset

setLineWidth

getLineWidth

setDrawBorder

isDrawBorder

setDrawOnChartArea

isDrawOnChartArea

setDrawTicks

isDrawTicks

setTickMarkLength

getTickMarkLength

setZeroLineWidth

getZeroLineWidth

setZeroLineColor

setZeroLineColor

getZeroLineColorAsString

getZeroLineColor

setZeroLineBorderDash

getZeroLineBorderDash

setZeroLineBorderDashOffset

getZeroLineBorderDashOffset

setOffsetGridLines

isOffsetGridLines