org.fujion.highcharts

Class ButtonOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.ButtonOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter

public class ButtonOptions
extends Options

Options for buttons (e.g., print or export buttons).

Field Summary

Fields

Modifier and Type	Field and Description
AlignHorizontal	align Alignment for the buttons.
String	backgroundColor Background color for the buttons.
String	borderColor The border color of the buttons.
Integer	borderRadius The border corner radius of the buttons.
Integer	borderWidth The border width of the buttons.
Boolean	enabled Whether to enable buttons.
Integer	height Pixel height of the buttons.
String	hoverBorderColor Color of the button border on hover.
String	hoverSymbolFill Defaults to #768F3E.
String	hoverSymbolStroke Stroke (line) color for the symbol within the button on hover.
List<ActionOptions>	menuItems A collection of config options for the menu items.
String	onclick A click handler callback to use on the button directly instead of the default.
String	symbol The symbol for the button.
String	symbolFill Defaults to #A8BF77.
Integer	symbolSize The pixel size of the symbol on the button.
String	symbolStroke The color of the symbol's stroke or line.
Integer	symbolStrokeWidth The pixel stroke width of the symbol on the button.
Double	symbolX The x position of the center of the symbol inside the button.
Double	symbolY The y position of the center of the symbol inside the button.
String	text A text string to add to the individual button.
AlignVertical	verticalAlign The vertical alignment of the buttons.
Integer	width The pixel width of the button.
Integer	x The horizontal position of the button relative to the align option.
Integer	y The vertical offset of the button's position relative to its verticalAlign.

Constructor Summary

Constructors

Constructor and Description
ButtonOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

copyTo, toMap

Methods inherited from class java.lang.Object

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

Field Detail

align

public AlignHorizontal align

Alignment for the buttons. Defaults to "right".

backgroundColor

public String backgroundColor

Background color for the buttons.

borderColor

public String borderColor

The border color of the buttons. Defaults to "#B0B0B0".

borderRadius

public Integer borderRadius

The border corner radius of the buttons. Defaults to 3.

borderWidth

public Integer borderWidth

The border width of the buttons. Defaults to 1.

enabled

public Boolean enabled

Whether to enable buttons. Defaults to true.

height

public Integer height

Pixel height of the buttons. Defaults to 20.

hoverBorderColor

public String hoverBorderColor

Color of the button border on hover. Defaults to #909090.

hoverSymbolFill

public String hoverSymbolFill

Defaults to #768F3E.

hoverSymbolStroke

public String hoverSymbolStroke

Stroke (line) color for the symbol within the button on hover. Defaults to #4572A5.

menuItems

public final List<ActionOptions> menuItems

A collection of config options for the menu items. Each options object consists of a text option which is a string to show in the menu item, as well as an onclick parameter which is a callback function to run on click. By default, there is one menu item for each of the available export types. Menu items can be customized by defining a new array of items and assigning null to unwanted positions.

onclick

@JavaScript
public String onclick

A click handler callback to use on the button directly instead of the default. The "this" variable will be the Highcharts object.

symbol

public String symbol

The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The default exportIcon function is part of the exporting module. Defaults to "exportIcon".

symbolFill

public String symbolFill

Defaults to #A8BF77.

symbolSize

public Integer symbolSize

The pixel size of the symbol on the button. Defaults to 12.

symbolStroke

public String symbolStroke

The color of the symbol's stroke or line. Defaults to "#A0A0A0".

symbolStrokeWidth

public Integer symbolStrokeWidth

The pixel stroke width of the symbol on the button. Defaults to 1.

symbolX

public Double symbolX

The x position of the center of the symbol inside the button. Defaults to 11.5.

symbolY

public Double symbolY

The y position of the center of the symbol inside the button. Defaults to 10.5.

text

public String text

A text string to add to the individual button. Defaults to null.

verticalAlign

public AlignVertical verticalAlign

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

width

public Integer width

The pixel width of the button. Defaults to 24.

x

public Integer x

The horizontal position of the button relative to the align option. Defaults to 10.

y

public Integer y

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

Constructor Detail

ButtonOptions

public ButtonOptions()