CrosshairHintBehavior Class

A hint behaves like a crosshair cursor.

Declaration

public class CrosshairHintBehavior
extends HintBehavior

Remarks

Crosshair hint behavior

Inheritance

Object
ChartElement
HintBehavior
CrosshairHintBehavior

Inherited Members

java.lang.Object.equals(java.lang.Object)
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long, int)

Constructors

CrosshairHintBehavior() Constructor

Initializes a new CrosshairHintBehavior class instance with default parameters.

Declaration

public CrosshairHintBehavior()

Methods

CrosshairHintBehavior.getGroupHeaderTextPattern() Method

Returns the group header's text pattern.

Declaration

public String getGroupHeaderTextPattern()

Returns

Type Description
String

The string that specifies a pattern for the group header's text.

CrosshairHintBehavior.getLabelPosition() Method

Returns the CrosshairLabelPositionBase descendant that defines the crosshair's label position.

Declaration

public CrosshairLabelPositionBase getLabelPosition()

Returns

Type Description
CrosshairLabelPositionBase

The CrosshairLabelPositionBase descendant that specifies the crosshair's label position.

CrosshairHintBehavior.getMaxSeriesCount() Method

Returns the maximum number of series that the crosshair can highlight.

Declaration

public int getMaxSeriesCount()

Returns

Type Description
int

The series count.

CrosshairHintBehavior.isArgumentLabelVisible() Method

Returns the value that indicates whether a crosshair cursor's argument label is visible.

Declaration

public boolean isArgumentLabelVisible()

Returns

Type Description
boolean

true if the argument label is displayed on an appropriate axis; otherwise false.

CrosshairHintBehavior.isArgumentLineVisible() Method

Returns the value that indicates whether a crosshair cursor's argument line is visible.

Declaration

public boolean isArgumentLineVisible()

Returns

Type Description
boolean

true if the argument line is displayed; otherwise false.

CrosshairHintBehavior.isGroupHeaderVisible() Method

Returns the value that indicates whether the crosshair cursor's group header is visible.

Declaration

public boolean isGroupHeaderVisible()

Returns

Type Description
boolean

true if the group header is visible; otherwise false.

CrosshairHintBehavior.isHighlightPoint() Method

Returns the value that indicates whether the series point is highlighted when the crosshair cursor hovers over it.

Declaration

public boolean isHighlightPoint()

Returns

Type Description
boolean

true if the point is highlighted; otherwise false.

CrosshairHintBehavior.isValueLabelVisible() Method

Returns the value that indicates whether a crosshair cursor's value label is visible.

Declaration

public boolean isValueLabelVisible()

Returns

Type Description
boolean

true if the value label is displayed on an appropriate axis; otherwise false.

CrosshairHintBehavior.isValueLineVisible() Method

Returns the value that indicates whether a crosshair cursor's value line is visible.

Declaration

public boolean isValueLineVisible()

Returns

Type Description
boolean

true if the value line is displayed; otherwise false.

CrosshairHintBehavior.setArgumentLabelVisible(boolean) Method

Specifies the value that indicates whether a crosshair cursor's argument label is visible.

Declaration

public void setArgumentLabelVisible(boolean visible)

Parameters

Type Name Description
boolean visible

true if the argument label is displayed on an appropriate axis; otherwise false.

CrosshairHintBehavior.setArgumentLineVisible(boolean) Method

Specifies the value that indicates whether a crosshair cursor's argument line is visible.

Declaration

public void setArgumentLineVisible(boolean visible)

Parameters

Type Name Description
boolean visible

true if the argument line is displayed; otherwise false.

CrosshairHintBehavior.setGroupHeaderTextPattern(String) Method

Specifies the group header's text pattern.

Declaration

public void setGroupHeaderTextPattern(String pattern)

Parameters

Type Name Description
String pattern

The string that specifies a pattern for the group header's text.

The following placeholders can be used in the pattern:

Placeholder Description
A Displays a series point argument.

CrosshairHintBehavior.setGroupHeaderVisible(boolean) Method

Specifies the value that indicates whether the crosshair cursor's group header is visible.

Declaration

public void setGroupHeaderVisible(boolean visible)

Parameters

Type Name Description
boolean visible

true if the group header is visible; otherwise false.

CrosshairHintBehavior.setHighlightPoint(boolean) Method

Specifies the value that indicates whether the series point is highlighted when the crosshair cursor hovers over it.

Declaration

public void setHighlightPoint(boolean highlight)

Parameters

Type Name Description
boolean highlight

true if the point is highlighted; otherwise false.

CrosshairHintBehavior.setLabelPosition(CrosshairLabelPositionBase) Method

Specifies the CrosshairLabelPositionBase descendant that defines the crosshair's label position.

Declaration

public void setLabelPosition(CrosshairLabelPositionBase mode)

Parameters

Type Name Description
CrosshairLabelPositionBase mode

The CrosshairLabelPositionBase descendant that specifies the crosshair's label position.

CrosshairHintBehavior.setMaxSeriesCount(int) Method

Specifies the maximum number of series that can be highlighted by the crosshair.

Declaration

public void setMaxSeriesCount(int seriesCount)

Parameters

Type Name Description
int seriesCount

The series count.

CrosshairHintBehavior.setValueLabelVisible(boolean) Method

Specifies the value that indicates whether a crosshair cursor's value label is visible.

Declaration

public void setValueLabelVisible(boolean visible)

Parameters

Type Name Description
boolean visible

true if the value label is displayed on an appropriate axis; otherwise false.

CrosshairHintBehavior.setValueLineVisible(boolean) Method

Specifies the value that indicates whether a crosshair cursor's value line is visible.

Declaration

public void setValueLineVisible(boolean visible)

Parameters

Type Name Description
boolean visible

true if the value line is displayed; otherwise false.