com.highsoft.highcharts.common.hichartsclasses

Class HICrosshair

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HICrosshair

public class HICrosshair
extends HIFoundation

Constructor Summary

Constructors

Constructor and Description
HICrosshair()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName()
HIColor	getColor()
java.lang.String	getDashStyle()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.Boolean	getSnap()
java.lang.Number	getWidth()
java.lang.Number	getZIndex()
void	setClassName(java.lang.String className) A class name for the crosshair, especially as a hook for styling.
void	setColor(HIColor color) The color of the crosshair.
void	setDashStyle(java.lang.String dashStyle) The dash style for the crosshair.
void	setSnap(java.lang.Boolean snap) Whether the crosshair should snap to the point or follow the pointer independent of points.
void	setWidth(java.lang.Number width) The pixel width of the crosshair.
void	setZIndex(java.lang.Number zIndex) The Z index of the crosshair.

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

HICrosshair

public HICrosshair()

Method Detail

getClassName

public java.lang.String getClassName()

getColor

public HIColor getColor()

getDashStyle

public java.lang.String getDashStyle()

getParams

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

Specified by:

getParams in class HIFoundation

getSnap

public java.lang.Boolean getSnap()

getWidth

public java.lang.Number getWidth()

getZIndex

public java.lang.Number getZIndex()

setClassName

public void setClassName(java.lang.String className)

A class name for the crosshair, especially as a hook for styling.

setColor

public void setColor(HIColor color)

The color of the crosshair. Defaults to `#cccccc` for numeric and datetime axes, and `rgba(204,214,235,0.25)` for category axes, where the crosshair by defaults highlights the whole category.

defaults:

 #cccccc

setDashStyle

public void setDashStyle(java.lang.String dashStyle)

The dash style for the crosshair. See `plotOptions.series.dashStyle` for possible values.

defaults:

 Solid

setSnap

public void setSnap(java.lang.Boolean snap)

Whether the crosshair should snap to the point or follow the pointer independent of points.

defaults:

 true

setWidth

public void setWidth(java.lang.Number width)

The pixel width of the crosshair. Defaults to 1 for numeric or datetime axes, and for one category width for category axes.

defaults:

 1

setZIndex

public void setZIndex(java.lang.Number zIndex)

The Z index of the crosshair. Higher Z indices allow drawing the crosshair on top of the series or behind the grid lines.

defaults:

 2