org.fujion.highcharts

Class PlotBandOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotBandOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotBandOptions
extends Options

Options for a colored band stretching across the plot area marking an interval on the axis.

Field Summary

Fields

Modifier and Type	Field and Description
String	color The color of the plot band.
LinearGradient	color_linearGradient The linear gradient that defines the line which defines the direction of the gradient.
RadialGradient	color_radialGradient The radial gradient that defines the line which defines the direction of the gradient.
String[][]	color_stops The "stops" that define where the color transitions happen in the linear gradient.
Double	from The start position of the plot band in axis units.
String	id An id used for identifying the plot band in Axis.removePlotBand.
Double	to The end position of the plot band in axis units.
Integer	zIndex The z index of the plot band within the chart.

Constructor Summary

Constructors

Constructor and Description
PlotBandOptions()

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

color

@Option
public String color

The color of the plot band.

color_linearGradient

@Option(value="color.linearGradient")
public final LinearGradient color_linearGradient

The linear gradient that defines the line which defines the direction of the gradient.

color_radialGradient

@Option(value="color.radialGradient")
public final RadialGradient color_radialGradient

The radial gradient that defines the line which defines the direction of the gradient.

color_stops

@Option(value="color.stops")
public String[][] color_stops

The "stops" that define where the color transitions happen in the linear gradient. The first element is a value between 0 and 1 that define where along the line the transition happens (like a percentage) and the second element is the actual color (#FFBBAA for example).

from

@Option
public Double from

The start position of the plot band in axis units. Defaults to null.

id

@Option
public String id

An id used for identifying the plot band in Axis.removePlotBand. Defaults to null.

to

@Option
public Double to

The end position of the plot band in axis units. Defaults to null.

zIndex

@Option
public Integer zIndex

The z index of the plot band within the chart. Defaults to null.

Constructor Detail

PlotBandOptions

public PlotBandOptions()