Package org.primefaces.model.charts.axes

Class AxesGridLines

java.lang.Object

org.primefaces.model.charts.axes.AxesGridLines

All Implemented Interfaces:

Serializable

public class AxesGridLines
extends Object
implements Serializable

The grid line configuration is nested under the scale configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AxesGridLines()

Method Summary

Modifier and Type	Method	Description
String	encode()	Write the common ticks options of axes
List<Number>	getBorderDash()	Gets the borderDash
Number	getBorderDashOffset()	Gets the borderDashOffset
Object	getColor()	Gets the color
Object	getLineWidth()	Gets the lineWidth
Number	getTickMarkLength()	Gets the tickMarkLength
List<Number>	getZeroLineBorderDash()	Gets the zeroLineBorderDash
Number	getZeroLineBorderDashOffset()	Gets the zeroLineBorderDashOffset
String	getZeroLineColor()	Gets the zeroLineColor
Number	getZeroLineWidth()	Gets the zeroLineWidth
boolean	isDisplay()	Gets the display
boolean	isDrawBorder()	Gets the drawBorder
boolean	isDrawOnChartArea()	Gets the drawOnChartArea
boolean	isDrawTicks()	Gets the drawTicks
boolean	isOffsetGridLines()	Gets the offsetGridLines
void	setBorderDash(List<Number> borderDash)	Sets the borderDash
void	setBorderDashOffset(Number borderDashOffset)	Sets the borderDashOffset
void	setColor(Object color)	Sets the color
void	setDisplay(boolean display)	Sets the display
void	setDrawBorder(boolean drawBorder)	Sets the drawBorder
void	setDrawOnChartArea(boolean drawOnChartArea)	Sets the drawOnChartArea
void	setDrawTicks(boolean drawTicks)	Sets the drawTicks
void	setLineWidth(Object lineWidth)	Sets the lineWidth
void	setOffsetGridLines(boolean offsetGridLines)	Sets the offsetGridLines
void	setTickMarkLength(Number tickMarkLength)	Sets the tickMarkLength
void	setZeroLineBorderDash(List<Number> zeroLineBorderDash)	Sets the zeroLineBorderDash
void	setZeroLineBorderDashOffset(Number zeroLineBorderDashOffset)	Sets the zeroLineBorderDashOffset
void	setZeroLineColor(String zeroLineColor)	Sets the zeroLineColor
void	setZeroLineWidth(Number zeroLineWidth)	Sets the zeroLineWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

AxesGridLines

public AxesGridLines()

Method Detail

isDisplay

public boolean isDisplay()

Gets the display

Returns:

display

setDisplay

public void setDisplay(boolean display)

Sets the display

Parameters:

display - If false, do not display grid lines for this axis.

getColor

public Object getColor()

Gets the color

Returns:

color

setColor

public void setColor(Object color)

Sets the color

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.

getBorderDash

public List<Number> getBorderDash()

Gets the borderDash

Returns:

borderDash

setBorderDash

public void setBorderDash(List<Number> borderDash)

Sets the borderDash

Parameters:

borderDash - Length and spacing of dashes on grid lines.

getBorderDashOffset

public Number getBorderDashOffset()

Gets the borderDashOffset

Returns:

borderDashOffset

setBorderDashOffset

public void setBorderDashOffset(Number borderDashOffset)

Sets the borderDashOffset

Parameters:

borderDashOffset - Offset for line dashes.

getLineWidth

public Object getLineWidth()

Gets the lineWidth

Returns:

lineWidth

setLineWidth

public void setLineWidth(Object lineWidth)

Sets the lineWidth

Parameters:

lineWidth - Stroke width of grid lines.

isDrawBorder

public boolean isDrawBorder()

Gets the drawBorder

Returns:

drawBorder

setDrawBorder

public void setDrawBorder(boolean drawBorder)

Sets the drawBorder

Parameters:

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

isDrawOnChartArea

public boolean isDrawOnChartArea()

Gets the drawOnChartArea

Returns:

drawOnChartArea

setDrawOnChartArea

public void setDrawOnChartArea(boolean drawOnChartArea)

Sets the drawOnChartArea

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.

isDrawTicks

public boolean isDrawTicks()

Gets the drawTicks

Returns:

drawTicks

setDrawTicks

public void setDrawTicks(boolean drawTicks)

Sets the drawTicks

Parameters:

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

getTickMarkLength

public Number getTickMarkLength()

Gets the tickMarkLength

Returns:

tickMarkLength

setTickMarkLength

public void setTickMarkLength(Number tickMarkLength)

Sets the tickMarkLength

Parameters:

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

getZeroLineWidth

public Number getZeroLineWidth()

Gets the zeroLineWidth

Returns:

zeroLineWidth

setZeroLineWidth

public void setZeroLineWidth(Number zeroLineWidth)

Sets the zeroLineWidth

Parameters:

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

getZeroLineColor

public String getZeroLineColor()

Gets the zeroLineColor

Returns:

zeroLineColor

setZeroLineColor

public void setZeroLineColor(String zeroLineColor)

Sets the zeroLineColor

Parameters:

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

getZeroLineBorderDash

public List<Number> getZeroLineBorderDash()

Gets the zeroLineBorderDash

Returns:

zeroLineBorderDash

setZeroLineBorderDash

public void setZeroLineBorderDash(List<Number> zeroLineBorderDash)

Sets the zeroLineBorderDash

Parameters:

zeroLineBorderDash - Length and spacing of dashes of the grid line for the first index (index 0).

getZeroLineBorderDashOffset

public Number getZeroLineBorderDashOffset()

Gets the zeroLineBorderDashOffset

Returns:

zeroLineBorderDashOffset

setZeroLineBorderDashOffset

public void setZeroLineBorderDashOffset(Number zeroLineBorderDashOffset)

Sets the zeroLineBorderDashOffset

Parameters:

zeroLineBorderDashOffset - Offset for line dashes of the grid line for the first index (index 0).

isOffsetGridLines

public boolean isOffsetGridLines()

Gets the offsetGridLines

Returns:

offsetGridLines

setOffsetGridLines

public void setOffsetGridLines(boolean offsetGridLines)

Sets the offsetGridLines

Parameters:

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

encode

public String encode()
              throws IOException

Write the common ticks options of axes

Returns:

options as JSON object

Throws:

IOException - If an I/O error occurs