com.highsoft.highcharts.common.hichartsclasses

Class HIPlotBands

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPlotBands

public class HIPlotBands
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPlotBands()

Method Summary

Modifier and Type	Method and Description
void	destroy() Remove the plot band.
HIColor	getBorderColor()
java.lang.Number	getBorderWidth()
java.lang.String	getClassName()
HIColor	getColor()
HIEvents	getEvents()
java.lang.Number	getFrom()
java.lang.String	getId()
java.lang.Object	getInnerRadius()
HILabel	getLabel()
java.lang.Object	getOuterRadius()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Object	getThickness()
java.lang.Number	getTo()
java.lang.Number	getZIndex()
void	setBorderColor(HIColor borderColor) Border color for the plot band.
void	setBorderWidth(java.lang.Number borderWidth) Border width for the plot band.
void	setClassName(java.lang.String className) A custom class name, in addition to the defaults `highcharts-plot-band`, to apply to each individual band.
void	setColor(HIColor color) The color of the plot band.
void	setEvents(HIEvents events) An object defining mouse events for the plot band.
void	setFrom(java.lang.Number from) The start position of the plot band in axis units.
void	setId(java.lang.String id) An id used for identifying the plot band in Axis.removePlotBand.
void	setInnerRadius(java.lang.Object innerRadius) In a gauge chart, this option determines the inner radius of the plot band that stretches along the perimeter.
void	setLabel(HILabel label) Text labels for the plot bands
void	setOuterRadius(java.lang.Object outerRadius) In a gauge chart, this option determines the outer radius of the plot band that stretches along the perimeter.
void	setThickness(java.lang.Object thickness) In a gauge chart, this option sets the width of the plot band stretching along the perimeter.
void	setTo(java.lang.Number to) The end position of the plot band in axis units.
void	setZIndex(java.lang.Number zIndex) The z index of the plot band within the chart, relative to other elements.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

HIPlotBands

public HIPlotBands()

Method Detail

destroy

public void destroy()

Remove the plot band.

getBorderColor

public HIColor getBorderColor()

getBorderWidth

public java.lang.Number getBorderWidth()

getClassName

public java.lang.String getClassName()

getColor

public HIColor getColor()

getEvents

public HIEvents getEvents()

getFrom

public java.lang.Number getFrom()

getId

public java.lang.String getId()

getInnerRadius

public java.lang.Object getInnerRadius()

getLabel

public HILabel getLabel()

getOuterRadius

public java.lang.Object getOuterRadius()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Specified by:

getParams in class HIFoundation

getThickness

public java.lang.Object getThickness()

getTo

public java.lang.Number getTo()

getZIndex

public java.lang.Number getZIndex()

setBorderColor

public void setBorderColor(HIColor borderColor)

Border color for the plot band. Also requires `borderWidth` to be set.

setBorderWidth

public void setBorderWidth(java.lang.Number borderWidth)

Border width for the plot band. Also requires `borderColor` to be set.

defaults:

 0

setClassName

public void setClassName(java.lang.String className)

A custom class name, in addition to the defaults `highcharts-plot-band`, to apply to each individual band.

setColor

public void setColor(HIColor color)

The color of the plot band.

defaults:

 #e6e9ff

setEvents

public void setEvents(HIEvents events)

An object defining mouse events for the plot band. Supported properties are `click`, `mouseover`, `mouseout`, `mousemove`.

setFrom

public void setFrom(java.lang.Number from)

The start position of the plot band in axis units.

setId

public void setId(java.lang.String id)

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

setInnerRadius

public void setInnerRadius(java.lang.Object innerRadius)

In a gauge chart, this option determines the inner radius of the plot band that stretches along the perimeter. It can be given as a percentage string, like `"100%"`, or as a pixel number, like `100`. By defaults, the inner radius is controlled by the `thickness` option.

setLabel

public void setLabel(HILabel label)

Text labels for the plot bands

setOuterRadius

public void setOuterRadius(java.lang.Object outerRadius)

In a gauge chart, this option determines the outer radius of the plot band that stretches along the perimeter. It can be given as a percentage string, like `"100%"`, or as a pixel number, like `100`.

defaults:

 100%

setThickness

public void setThickness(java.lang.Object thickness)

In a gauge chart, this option sets the width of the plot band stretching along the perimeter. It can be given as a percentage string, like `"10%"`, or as a pixel number, like `10`. The defaults value 10 is the same as the defaults `tickLength`, thus making the plot band act as a background for the tick markers.

defaults:

 10

setTo

public void setTo(java.lang.Number to)

The end position of the plot band in axis units.

setZIndex

public void setZIndex(java.lang.Number zIndex)

The z index of the plot band within the chart, relative to other elements. Using the same z index as another element may give unpredictable results, as the last rendered element will be on top. Values from 0 to 20 make sense.