Interface IsDefaultGrid
-
- All Superinterfaces:
IsDefaultScaleLines
- All Known Implementing Classes:
DefaultChartGrid
,DefaultGrid
,Grid
public interface IsDefaultGrid extends IsDefaultScaleLines
Interface to define grid defaults.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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 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()
Iftrue
, grid are circular (on radar chart only).boolean
isDisplay()
Iffalse
, do not display grid for this axis.boolean
isDrawOnChartArea()
Iftrue
, 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()
Iftrue
, draw lines beside the ticks in the axis area beside the chart.boolean
isOffset()
Iftrue
, grid will be shifted to be between labels.-
Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultScaleLines
getColorAsString, getLineWidth
-
-
-
-
Method Detail
-
isDisplay
boolean isDisplay()
Iffalse
, do not display grid for this axis.- Returns:
- if
false
, do not display grid for this axis.
-
isDrawOnChartArea
boolean isDrawOnChartArea()
Iftrue
, 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.- 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
boolean isDrawTicks()
Iftrue
, 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.
-
getTickLength
int getTickLength()
Returns the length in pixels that the grid will draw in the axis area.- Returns:
- Length in pixels that the grid will draw in the axis area.
-
isOffset
boolean isOffset()
Iftrue
, grid will be shifted to be between labels. This is set totrue
in the bar chart by default.- Returns:
- If
true
, grid will be shifted to be between labels.
-
isCircular
boolean isCircular()
Iftrue
, grid are circular (on radar chart only).- Returns:
- If
true
, grid are circular (on radar chart only).
-
getZ
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.- Returns:
- z-index of grid layer.
Values less than or equals to 0 are drawn under data sets, greater than 0 on top.
-
getTickBorderDashOffset
double getTickBorderDashOffset()
Returns the offset for the line dash of the tick mark.- Returns:
- the offset for the line dash of the tick mark
-
getTickColorAsString
String getTickColorAsString()
Returns the color of the tick line.- Returns:
- the color of the tick line.
-
getTickWidth
int getTickWidth()
Returns the width of the tick mark in pixels.
The first element if set as array.- Returns:
- stroke width of grid.
The first element if set as array.
-
-