org.fujion.highcharts

Class PaneOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PaneOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PaneOptions
extends Options

Applies only to polar charts and angular gauges. This configuration object holds general options for the combined X and Y axes set. Each xAxis or yAxis can reference the pane by index.

Field Summary

Fields

Modifier and Type	Field and Description
List<Object>	background An object, or array of objects, for backgrounds.
List<String>	center The center of a polar chart or angular gauge, given as an array of [x, y] positions.
Integer	endAngle The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north.
String	size The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are.
Integer	startAngle The start angle of the polar X axis or gauge axis, given in degrees where 0 is north.

Constructor Summary

Constructors

Constructor and Description
PaneOptions()

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

background

@Option
public final List<Object> background

An object, or array of objects, for backgrounds. Sub options include backgroundColor (which can be solid or gradient), innerWidth, outerWidth, borderWidth, borderColor.

center

@Option
public final List<String> center

The center of a polar chart or angular gauge, given as an array of [x, y] positions. Positions can be given as integers that transform to pixels, or as percentages of the plot area size. Defaults to ['50%', '50%'].

endAngle

@Option
public Integer endAngle

The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. Defaults to startAngle + 360. Defaults to undefined.

size

@Option
public String size

The size of the pane, either as a number defining pixels, or a percentage defining a percentage of the plot are. Defaults to 85%.

startAngle

@Option
public Integer startAngle

The start angle of the polar X axis or gauge axis, given in degrees where 0 is north. Defaults to 0. Defaults to 0.

Constructor Detail

PaneOptions

public PaneOptions()