GridLines (Charba - GWT Charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.GridLines

All Implemented Interfaces:

IsDefaultGridLines
```
public final class GridLines
extends NativeObjectContainer
implements IsDefaultGridLines
```
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
`protected void`	`checkAndAddToParent()` Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
`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.
`int`	`getBorderDashOffset()` Returns the line dash pattern offset or "phase".
`protected Key`	`getChildKey()` Returns the property name to use to add this element to its parent.
`List<IsColor>`	`getColor()` The color of the grid lines.
`String`	`getColorAsString()` The color of the grid lines.
`List<String>`	`getColorsAsString()` The color of the grid lines.
`protected D`	`getDefaultValues()` Returns the default provider instance.
`List<Integer>`	`getLinesWidth()` Returns the stroke widths of grid lines.
`int`	`getLineWidth()` Returns the stroke width of grid lines.
`protected P`	`getParent()` Returns the parent element.
`int`	`getTickMarkLength()` Returns the length in pixels that the grid lines will draw into the axis area.
`int`	`getZ()` Returns z-index of gridline layer.
`List<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).
`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.
`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".
`protected void`	`setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for callbacks) to a model at the specific key.
`void`	`setCircular(boolean circular)` If `true`, gridlines are circular (on radar chart only).
`void`	`setColor(IsColor... color)` The color of the grid lines.
`void`	`setColor(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.
`protected void`	`setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for events) to a model at the specific key.
`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`	`setZ(int z)` Sets z-index of gridline layer.
`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(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.commons.NativeObjectContainer
checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultGridLines
getBorderDashOffset

- 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.
    
    Specified by:
    
    isDisplay in interface IsDefaultGridLines
    
    Returns:
    
    If false, do not display grid lines for this axis.
  - setCircular
```
public void setCircular(boolean circular)
```
    If true, gridlines are circular (on radar chart only).
    
    Parameters:
    
    circular - If true, gridlines are circular (on radar chart only).
  - isCircular
```
public boolean isCircular()
```
    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).
  - 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(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 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.
    
    Specified by:
    
    getColorAsString in interface IsDefaultGridLines
    
    Returns:
    
    the list of colors of the grid lines.
  - getColorsAsString
```
public List<String> getColorsAsString()
```
    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.
  - getColor
```
public 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.
  - setLineWidth
```
public void setLineWidth(int... lineWidth)
```
    Sets the stroke widths of grid lines.
    
    Parameters:
    
    lineWidth - stroke widths of grid lines.
  - getLineWidth
```
public int getLineWidth()
```
    Returns the stroke width of grid lines. The first element if set as array.
    
    Specified by:
    
    getLineWidth in interface IsDefaultGridLines
    
    Returns:
    
    lineWidth stroke width of grid lines. The first element if set as array.
  - getLinesWidth
```
public List<Integer> getLinesWidth()
```
    Returns the stroke widths of grid lines.
    
    Returns:
    
    lineWidth stroke widths of grid lines.
  - 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.
    
    Specified by:
    
    isDrawBorder in interface IsDefaultGridLines
    
    Returns:
    
    If true, draw border at the edge between the axis and the chart area.
  - 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.
    
    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.
  - 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.
    
    Specified by:
    
    isDrawTicks in interface IsDefaultGridLines
    
    Returns:
    
    If true, draw lines beside the ticks in the axis area beside the chart.
  - 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.
    
    Specified by:
    
    getTickMarkLength in interface IsDefaultGridLines
    
    Returns:
    
    Length in pixels that the grid lines will draw into the axis area.
  - 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).
    
    Specified by:
    
    getZeroLineWidth in interface IsDefaultGridLines
    
    Returns:
    
    Stroke width of the grid line for the first index (index 0).
  - 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(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 String getZeroLineColorAsString()
```
    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).
  - 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).
  - 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 List<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).
    
    Specified by:
    
    getZeroLineBorderDashOffset in interface IsDefaultGridLines
    
    Returns:
    
    the offset for line dashes of the grid line for the first index (index 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.
    
    Specified by:
    
    isOffsetGridLines in interface IsDefaultGridLines
    
    Returns:
    
    if true, grid lines will be shifted to be between labels.
  - setZ
```
public void setZ(int z)
```
    Sets z-index of gridline layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
    
    Parameters:
    
    z - z-index of gridline layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
  - getZ
```
public int getZ()
```
    Returns z-index of gridline layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
    
    Specified by:
    
    getZ in interface IsDefaultGridLines
    
    Returns:
    
    z-index of gridline layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
  - setBorderDash
```
public final 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 final 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.
    
    Returns:
    
    the line dash pattern used when stroking lines
  - setBorderDashOffset
```
public final void setBorderDashOffset(int borderDashOffset)
```
    Sets the line dash pattern offset or "phase".
    
    Parameters:
    
    borderDashOffset - Offset for line dashes.
  - getBorderDashOffset
```
public final int getBorderDashOffset()
```
    Returns the line dash pattern offset or "phase".
    
    Returns:
    
    Offset for line dashes.
  - getChildKey
```
protected final Key getChildKey()
```
    Returns the property name to use to add this element to its parent.
    
    Returns:
    
    the childKey or null if is a root element.
  - getParent
```
protected final P getParent()
```
    Returns the parent element.
    
    Returns:
    
    the parent or null if is a root element.
  - getDefaultValues
```
protected final D getDefaultValues()
```
    Returns the default provider instance.
    
    Returns:
    
    the default provider instance.
  - setEventToModel
```
protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for events) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - setCallbackToModel
```
protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for callbacks) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - checkAndAddToParent
```
protected final void checkAndAddToParent()
```
    Called recursively when a property has been set in the item.
    This is mandatory because it could happen that the parent item is not present, therefore it must be added.

Class GridLines

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultGridLines

Method Detail

setDisplay

isDisplay

setCircular

isCircular

setColor

setColor

getColorAsString

getColorsAsString

getColor

setLineWidth

getLineWidth

getLinesWidth

setDrawBorder

isDrawBorder

setDrawOnChartArea

isDrawOnChartArea

setDrawTicks

isDrawTicks

setTickMarkLength

getTickMarkLength

setZeroLineWidth

getZeroLineWidth

setZeroLineColor

setZeroLineColor

getZeroLineColorAsString

getZeroLineColor

setZeroLineBorderDash

getZeroLineBorderDash

setZeroLineBorderDashOffset

getZeroLineBorderDashOffset

setOffsetGridLines

isOffsetGridLines

setZ

getZ

setBorderDash

getBorderDash

setBorderDashOffset

getBorderDashOffset

getChildKey

getParent

getDefaultValues

setEventToModel

setCallbackToModel

checkAndAddToParent