com.highsoft.highcharts.common.hichartsclasses

Class HIAxisPlotLinePathOptionsObject

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HIAxisPlotLinePathOptionsObject

public class HIAxisPlotLinePathOptionsObject
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HIAxisPlotLinePathOptionsObject()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAcrossPanes()
java.lang.String	getForce()
java.lang.Number	getLineWidth()
java.lang.Boolean	getOld()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Boolean	getReverse()
java.lang.Number	getTranslatedValue()
java.lang.Number	getValue()
void	setAcrossPanes(java.lang.Boolean acrossPanes) Used in Highcharts Stock.
void	setForce(java.lang.String force) If `false`, the function will return null when it falls outside the axis bounds.
void	setLineWidth(java.lang.Number lineWidth) Line width used for calculation crisp line coordinates.
void	setOld(java.lang.Boolean old) Use old coordinates (for resizing and rescaling).
void	setReverse(java.lang.Boolean reverse) Used in Polar axes.
void	setTranslatedValue(java.lang.Number translatedValue) If given, return the plot line path of a pixel position on the axis.
void	setValue(java.lang.Number value) Axis value.

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

HIAxisPlotLinePathOptionsObject

public HIAxisPlotLinePathOptionsObject()

Method Detail

getAcrossPanes

public java.lang.Boolean getAcrossPanes()

getForce

public java.lang.String getForce()

getLineWidth

public java.lang.Number getLineWidth()

getOld

public java.lang.Boolean getOld()

getParams

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

Specified by:

getParams in class HIFoundation

getReverse

public java.lang.Boolean getReverse()

getTranslatedValue

public java.lang.Number getTranslatedValue()

getValue

public java.lang.Number getValue()

setAcrossPanes

public void setAcrossPanes(java.lang.Boolean acrossPanes)

Used in Highcharts Stock. When `true`, plot paths (crosshair, plotLines, gridLines) will be rendered on all axes when defined on the first axis.

setForce

public void setForce(java.lang.String force)

If `false`, the function will return null when it falls outside the axis bounds. If `true`, the function will return a path aligned to the plot area sides if it falls outside. If `pass`, it will return a path outside.

setLineWidth

public void setLineWidth(java.lang.Number lineWidth)

Line width used for calculation crisp line coordinates. Defaults to 1.

setOld

public void setOld(java.lang.Boolean old)

Use old coordinates (for resizing and rescaling). If not set, defaultss to `false`.

setReverse

public void setReverse(java.lang.Boolean reverse)

Used in Polar axes. Reverse the positions for concatenation of polygonal plot bands

setTranslatedValue

public void setTranslatedValue(java.lang.Number translatedValue)

If given, return the plot line path of a pixel position on the axis.

setValue

public void setValue(java.lang.Number value)

Axis value.