Package com.vaadin.flow.component.charts.model

Class AxisGrid

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.AxisGrid

All Implemented Interfaces:

Serializable

public class AxisGrid
extends AbstractConfigurationObject

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AxisGrid()

Method Summary

Modifier and Type	Method	Description
void	addColumn(XAxis column)	Add a new column to the grid.
Color	getBorderColor()
Number	getBorderWidth()
Number	getCellHeight()
List<XAxis>	getColumns()
Boolean	getEnabled()
void	setBorderColor(Color borderColor)	Set border color for the label grid lines.
void	setBorderWidth(Number borderWidth)	Set border width of the label grid lines.
void	setCellHeight(Number cellHeight)	Set cell height for grid axis labels.
void	setColumns(List<XAxis> columns)	Set specific options for each column (or row for horizontal axes) in the grid.
void	setEnabled(Boolean enabled)	Enable grid on the axis labels.

Methods inherited from class java.lang.Object

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

Constructor Details

AxisGrid

public AxisGrid()

Method Details

getBorderColor

public Color getBorderColor()

See Also:

• setBorderColor(Color)

setBorderColor

public void setBorderColor(Color borderColor)

Set border color for the label grid lines. Defaults to undefined.

getBorderWidth

public Number getBorderWidth()

See Also:

• setBorderWidth(Number)

setBorderWidth

public void setBorderWidth(Number borderWidth)

Set border width of the label grid lines. Defaults to 1.

getCellHeight

public Number getCellHeight()

See Also:

• setCellHeight(Number)

setCellHeight

public void setCellHeight(Number cellHeight)

Set cell height for grid axis labels. By default this is calculated from font size. This option only applies to horizontal axes. Defaults to undefined.

getColumns

public List<XAxis> getColumns()

See Also:

• setColumns(List)

setColumns

public void setColumns(List<XAxis> columns)

Set specific options for each column (or row for horizontal axes) in the grid. Each extra column/row is its own axis, and the axis options can be set here. Defaults to undefined.

addColumn

public void addColumn(XAxis column)

Add a new column to the grid. See setColumns(List)

Parameters:

column - A column to be added

getEnabled

public Boolean getEnabled()

See Also:

• setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Enable grid on the axis labels. Defaults to true for Gantt charts. Defaults to true.