com.highsoft.highcharts.common.hichartsclasses

Class HIPlotLines

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIPlotLines

public class HIPlotLines
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIPlotLines()

Method Summary

Modifier and Type	Method and Description
void	destroy() Remove the plot line.
java.lang.String	getClassName()
HIColor	getColor()
java.lang.String	getDashStyle()
HIEvents	getEvents()
java.lang.String	getId()
HILabel	getLabel()
HILabels	getLabels()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Number	getValue()
java.lang.Number	getWidth()
java.lang.Number	getZIndex()
void	setClassName(java.lang.String className) A custom class name, in addition to the defaults `highcharts-plot-line`, to apply to each individual line.
void	setColor(HIColor color) The color of the line.
void	setDashStyle(java.lang.String dashStyle) The dashing or dot style for the plot line.
void	setEvents(HIEvents events) An object defining mouse events for the plot line.
void	setId(java.lang.String id) An id used for identifying the plot line in Axis.removePlotLine.
void	setLabel(HILabel label) Text labels for the plot bands
void	setLabels(HILabels labels)
void	setValue(java.lang.Number value) The position of the line in axis units.
void	setWidth(java.lang.Number width) The width or thickness of the plot line.
void	setZIndex(java.lang.Number zIndex) The z index of the plot line within the chart.

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

HIPlotLines

public HIPlotLines()

Method Detail

destroy

public void destroy()

Remove the plot line.

getClassName

public java.lang.String getClassName()

getColor

public HIColor getColor()

getDashStyle

public java.lang.String getDashStyle()

getEvents

public HIEvents getEvents()

getId

public java.lang.String getId()

getLabel

public HILabel getLabel()

getLabels

public HILabels getLabels()

getParams

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

Specified by:

getParams in class HIFoundation

getValue

public java.lang.Number getValue()

getWidth

public java.lang.Number getWidth()

getZIndex

public java.lang.Number getZIndex()

setClassName

public void setClassName(java.lang.String className)

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

setColor

public void setColor(HIColor color)

The color of the line.

defaults:

 #999999

setDashStyle

public void setDashStyle(java.lang.String dashStyle)

The dashing or dot style for the plot line. For possible values see [this overview](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).

defaults:

 Solid

setEvents

public void setEvents(HIEvents events)

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

setId

public void setId(java.lang.String id)

An id used for identifying the plot line in Axis.removePlotLine.

setLabel

public void setLabel(HILabel label)

Text labels for the plot bands

setLabels

public void setLabels(HILabels labels)

setValue

public void setValue(java.lang.Number value)

The position of the line in axis units.

setWidth

public void setWidth(java.lang.Number width)

The width or thickness of the plot line.

defaults:

 2

setZIndex

public void setZIndex(java.lang.Number zIndex)

The z index of the plot line within the chart.