org.fujion.highcharts

Class ButtonOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.ButtonOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

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.
Integer	buttonSpacing The pixel spacing between buttons.
String	className The CSS class name of the context button.
Boolean	enabled Whether to enable buttons.
Integer	height Pixel height of the buttons.
String	menuClassName The class name of the menu appearing from the button.
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 #666666.
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

toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

align

@Option
public AlignHorizontal align

Alignment for the buttons. Defaults to "right".

buttonSpacing

@Option
public Integer buttonSpacing

The pixel spacing between buttons. Defaults to 3.

className

@Option
public String className

The CSS class name of the context button. Defaults to highcharts-contextbutton.

enabled

@Option
public Boolean enabled

Whether to enable buttons. Defaults to true.

height

@Option
public Integer height

Pixel height of the buttons. Defaults to 20.

menuClassName

@Option
public String menuClassName

The class name of the menu appearing from the button. Defaults to highcharts-contextmenu.

menuItems

@Option
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

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
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

@Option
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 menu.

symbolFill

@Option
public String symbolFill

Defaults to #666666.

symbolSize

@Option
public Integer symbolSize

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

symbolStroke

@Option
public String symbolStroke

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

symbolStrokeWidth

@Option
public Integer symbolStrokeWidth

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

symbolX

@Option
public Double symbolX

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

symbolY

@Option
public Double symbolY

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

text

@Option
public String text

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

verticalAlign

@Option
public AlignVertical verticalAlign

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

width

@Option
public Integer width

The pixel width of the button. Defaults to 24.

x

@Option
public Integer x

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

y

@Option
public Integer y

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

Constructor Detail

ButtonOptions

public ButtonOptions()