Class CrosshairState
- Direct Known Subclasses:
CategoryCrosshairState
,XYCrosshairState
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a newCrosshairState
instance that calculates distance in Java2D space.CrosshairState
(boolean calculateDistanceInDataSpace) Creates a newCrosshairState
instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the anchor point.double
Returns the x-coordinate (in data space) for the anchor point.double
Returns the y-coordinate (in data space) for the anchor point.double
Returns the distance between the anchor point and the current crosshair point.double
Get the x-value for the crosshair point.double
Get the y-value for the crosshair point.int
Returns the dataset index that the crosshair values relate to.int
Deprecated.As of version 1.0.11, the domain axis should be determined using the dataset index.int
Deprecated.As of version 1.0.11, the domain axis should be determined using the dataset index.void
Sets the anchor point.void
setAnchorX
(double x) Sets the x-coordinate (in data space) for the anchor point.void
setAnchorY
(double y) Sets the y-coordinate (in data space) for the anchor point.void
setCrosshairDistance
(double distance) Sets the distance between the anchor point and the current crosshair point.void
setCrosshairX
(double x) Sets the x coordinate for the crosshair.void
setCrosshairY
(double y) Sets the y coordinate for the crosshair.void
setDatasetIndex
(int index) Sets the dataset index that the current crosshair values relate to.void
updateCrosshairPoint
(double x, double y, double transX, double transY, PlotOrientation orientation) void
updateCrosshairPoint
(double x, double y, int domainAxisIndex, int rangeAxisIndex, double transX, double transY, PlotOrientation orientation) Evaluates a data point and if it is the closest to the anchor point it becomes the new crosshair point.void
updateCrosshairX
(double candidateX) Deprecated.void
updateCrosshairX
(double candidateX, int domainAxisIndex) Evaluates an x-value and if it is the closest to the anchor x-value it becomes the new crosshair value.void
updateCrosshairY
(double candidateY) Deprecated.void
updateCrosshairY
(double candidateY, int rangeAxisIndex) Evaluates a y-value and if it is the closest to the anchor y-value it becomes the new crosshair value.
-
Constructor Details
-
CrosshairState
public CrosshairState()Creates a newCrosshairState
instance that calculates distance in Java2D space. -
CrosshairState
Creates a newCrosshairState
instance.- Parameters:
calculateDistanceInDataSpace
- a flag that controls whether the distance is calculated in data space or Java2D space.
-
-
Method Details
-
getCrosshairDistance
Returns the distance between the anchor point and the current crosshair point.- Returns:
- The distance.
- Since:
- 1.0.3
- See Also:
-
setCrosshairDistance
Sets the distance between the anchor point and the current crosshair point. As each data point is processed, its distance to the anchor point is compared with this value and, if it is closer, the data point becomes the new crosshair point.- Parameters:
distance
- the distance.- See Also:
-
updateCrosshairPoint
public void updateCrosshairPoint(double x, double y, double transX, double transY, PlotOrientation orientation) Deprecated.UseupdateCrosshairPoint(double, double, int, int, double, double, PlotOrientation)
. See bug report 1086307.Evaluates a data point and if it is the closest to the anchor point it becomes the new crosshair point.To understand this method, you need to know the context in which it will be called. An instance of this class is passed to an
XYItemRenderer
as each data point is plotted. As the point is plotted, it is passed to this method to see if it should be the new crosshair point.- Parameters:
x
- x coordinate (measured against the domain axis).y
- y coordinate (measured against the range axis).transX
- x translated into Java2D space.transY
- y translated into Java2D space.orientation
- the plot orientation.
-
updateCrosshairPoint
public void updateCrosshairPoint(double x, double y, int domainAxisIndex, int rangeAxisIndex, double transX, double transY, PlotOrientation orientation) Evaluates a data point and if it is the closest to the anchor point it becomes the new crosshair point.To understand this method, you need to know the context in which it will be called. An instance of this class is passed to an
XYItemRenderer
as each data point is plotted. As the point is plotted, it is passed to this method to see if it should be the new crosshair point.- Parameters:
x
- x coordinate (measured against the domain axis).y
- y coordinate (measured against the range axis).domainAxisIndex
- the index of the domain axis for this point.rangeAxisIndex
- the index of the range axis for this point.transX
- x translated into Java2D space.transY
- y translated into Java2D space.orientation
- the plot orientation.- Since:
- 1.0.4
-
updateCrosshairX
Deprecated.UseupdateCrosshairX(double, int)
. See bug report 1086307.Evaluates an x-value and if it is the closest to the anchor x-value it becomes the new crosshair value.Used in cases where only the x-axis is numerical.
- Parameters:
candidateX
- x position of the candidate for the new crosshair point.
-
updateCrosshairX
Evaluates an x-value and if it is the closest to the anchor x-value it becomes the new crosshair value.Used in cases where only the x-axis is numerical.
- Parameters:
candidateX
- x position of the candidate for the new crosshair point.domainAxisIndex
- the index of the domain axis for this x-value.- Since:
- 1.0.4
-
updateCrosshairY
Deprecated.UseupdateCrosshairY(double, int)
. See bug report 1086307.Evaluates a y-value and if it is the closest to the anchor y-value it becomes the new crosshair value.Used in cases where only the y-axis is numerical.
- Parameters:
candidateY
- y position of the candidate for the new crosshair point.
-
updateCrosshairY
Evaluates a y-value and if it is the closest to the anchor y-value it becomes the new crosshair value.Used in cases where only the y-axis is numerical.
- Parameters:
candidateY
- y position of the candidate for the new crosshair point.rangeAxisIndex
- the index of the range axis for this y-value.- Since:
- 1.0.4
-
getAnchor
Returns the anchor point.- Returns:
- The anchor point.
- Since:
- 1.0.3
- See Also:
-
setAnchor
Sets the anchor point. This is usually the mouse click point in a chart panel, and the crosshair point will often be the data item that is closest to the anchor point.
Note that the x and y coordinates (in data space) are not updated by this method - the caller is responsible for ensuring that this happens in sync.- Parameters:
anchor
- the anchor point (null
permitted).- See Also:
-
getAnchorX
Returns the x-coordinate (in data space) for the anchor point.- Returns:
- The x-coordinate of the anchor point.
- Since:
- 1.0.3
-
setAnchorX
Sets the x-coordinate (in data space) for the anchor point. Note that this does NOT update the anchor itself - the caller is responsible for ensuring this is done in sync.- Parameters:
x
- the x-coordinate.- Since:
- 1.0.3
-
getAnchorY
Returns the y-coordinate (in data space) for the anchor point.- Returns:
- The y-coordinate of teh anchor point.
- Since:
- 1.0.3
-
setAnchorY
Sets the y-coordinate (in data space) for the anchor point. Note that this does NOT update the anchor itself - the caller is responsible for ensuring this is done in sync.- Parameters:
y
- the y-coordinate.- Since:
- 1.0.3
-
getCrosshairX
Get the x-value for the crosshair point.- Returns:
- The x position of the crosshair point.
- See Also:
-
setCrosshairX
Sets the x coordinate for the crosshair. This is the coordinate in data space measured against the domain axis.- Parameters:
x
- the coordinate.- See Also:
-
getCrosshairY
Get the y-value for the crosshair point. This is the coordinate in data space measured against the range axis.- Returns:
- The y position of the crosshair point.
- See Also:
-
setCrosshairY
Sets the y coordinate for the crosshair.- Parameters:
y
- the y coordinate.- See Also:
-
getDatasetIndex
Returns the dataset index that the crosshair values relate to. The dataset is mapped to specific axes, and this is how the crosshairs are mapped also.- Returns:
- The dataset index.
- Since:
- 1.0.11
- See Also:
-
setDatasetIndex
Sets the dataset index that the current crosshair values relate to.- Parameters:
index
- the dataset index.- Since:
- 1.0.11
- See Also:
-
getDomainAxisIndex
Deprecated.As of version 1.0.11, the domain axis should be determined using the dataset index.Returns the domain axis index for the crosshair x-value.- Returns:
- The domain axis index.
- Since:
- 1.0.4
-
getRangeAxisIndex
Deprecated.As of version 1.0.11, the domain axis should be determined using the dataset index.Returns the range axis index for the crosshair y-value.- Returns:
- The range axis index.
- Since:
- 1.0.4
-