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

Class ButtonOptions

java.lang.Object

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

com.vaadin.flow.component.charts.model.ButtonOptions

All Implemented Interfaces:

Serializable

public class ButtonOptions
extends AbstractConfigurationObject

A collection of options for buttons appearing in the exporting module.

In styled mode, the buttons are styled with the .highcharts-contextbutton and .highcharts-button-symbol class.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ButtonOptions()
ButtonOptions(Boolean enabled)
ButtonOptions(String text)

Method Summary

Modifier and Type	Method	Description
HorizontalAlign	getAlign()
Boolean	getEnabled()
Number	getHeight()
Color	getSymbolFill()
Number	getSymbolSize()
Color	getSymbolStroke()
Number	getSymbolStrokeWidth()
Number	getSymbolX()
Number	getSymbolY()
String	getText()
VerticalAlign	getVerticalAlign()
Number	getWidth()
Number	getY()
void	setAlign(HorizontalAlign align)	Alignment for the buttons.
void	setEnabled(Boolean enabled)	Whether to enable buttons.
void	setHeight(Number height)	Pixel height of the buttons.
void	setSymbolFill(Color symbolFill)	Fill color for the symbol within the button.
void	setSymbolSize(Number symbolSize)	The pixel size of the symbol on the button.
void	setSymbolStroke(Color symbolStroke)	The color of the symbol's stroke or line.
void	setSymbolStrokeWidth(Number symbolStrokeWidth)	The pixel stroke width of the symbol on the button.
void	setSymbolX(Number symbolX)	The x position of the center of the symbol inside the button.
void	setSymbolY(Number symbolY)	The y position of the center of the symbol inside the button.
void	setText(String text)	A text string to add to the individual button.
void	setVerticalAlign(VerticalAlign verticalAlign)	The vertical alignment of the buttons.
void	setWidth(Number width)	The pixel width of the button.
void	setY(Number y)	The vertical offset of the button's position relative to its verticalAlign.

Methods inherited from class java.lang.Object

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

Constructor Details

ButtonOptions

public ButtonOptions()

ButtonOptions

public ButtonOptions(Boolean enabled)

ButtonOptions

public ButtonOptions(String text)

Method Details

getAlign

public HorizontalAlign getAlign()

See Also:

• setAlign(HorizontalAlign)

setAlign

public void setAlign(HorizontalAlign align)

Alignment for the buttons.

Defaults to: right

getEnabled

public Boolean getEnabled()

See Also:

• setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Whether to enable buttons.

Defaults to: true

getHeight

public Number getHeight()

See Also:

• setHeight(Number)

setHeight

public void setHeight(Number height)

Pixel height of the buttons.

Defaults to: 20

getSymbolFill

public Color getSymbolFill()

See Also:

• setSymbolFill(Color)

setSymbolFill

public void setSymbolFill(Color symbolFill)

Fill color for the symbol within the button.

Defaults to: #666666

getSymbolSize

public Number getSymbolSize()

See Also:

• setSymbolSize(Number)

setSymbolSize

public void setSymbolSize(Number symbolSize)

The pixel size of the symbol on the button.

Defaults to: 14

getSymbolStroke

public Color getSymbolStroke()

See Also:

• setSymbolStroke(Color)

setSymbolStroke

public void setSymbolStroke(Color symbolStroke)

The color of the symbol's stroke or line.

Defaults to: #666666

getSymbolStrokeWidth

public Number getSymbolStrokeWidth()

See Also:

• setSymbolStrokeWidth(Number)

setSymbolStrokeWidth

public void setSymbolStrokeWidth(Number symbolStrokeWidth)

The pixel stroke width of the symbol on the button.

Defaults to: 1

getSymbolX

public Number getSymbolX()

See Also:

• setSymbolX(Number)

setSymbolX

public void setSymbolX(Number symbolX)

The x position of the center of the symbol inside the button.

Defaults to: 12.5

getSymbolY

public Number getSymbolY()

See Also:

• setSymbolY(Number)

setSymbolY

public void setSymbolY(Number symbolY)

The y position of the center of the symbol inside the button.

Defaults to: 10.5

getText

public String getText()

See Also:

• setText(String)

setText

public void setText(String text)

A text string to add to the individual button.

Defaults to: null

getVerticalAlign

public VerticalAlign getVerticalAlign()

See Also:

• setVerticalAlign(VerticalAlign)

setVerticalAlign

public void setVerticalAlign(VerticalAlign verticalAlign)

The vertical alignment of the buttons. Can be one of "top", "middle" or "bottom".

Defaults to: top

getWidth

public Number getWidth()

See Also:

• setWidth(Number)

setWidth

public void setWidth(Number width)

The pixel width of the button.

Defaults to: 24

getY

public Number getY()

See Also:

• setY(Number)

setY

public void setY(Number y)

The vertical offset of the button's position relative to its verticalAlign. .

Defaults to: 0