com.nchart3d.NChart.NChartCrosshair Class Reference

The NChartCrosshair class provides methods to control crosshairs - lines that are perpendicular to the axes and are to mark some position on the chart. More...

Inheritance diagram for com.nchart3d.NChart.NChartCrosshair:
com.nchart3d.NChart.NChartObject

Public Member Functions

 NChartCrosshair ()
 Create crosshair.
 
 NChartCrosshair (int color, float thickness, NChartPoint targetPoint)
 Create crosshair with color, thickness and target point. More...
 
NChartHair getXHair ()
 Hair for X-Axis.
 
NChartHair getYHair ()
 Hair for Y-Axis.
 
NChartHair getZHair ()
 Hair for Z-Axis.
 
NChartPoint getTargetPoint ()
 Target point for the crosshair. More...
 
void setTargetPoint (NChartPoint targetPoint)
 For details see getTargetPoint().
 
float getThickness ()
 Thickness of the crosshair in pixels. More...
 
void setThickness (float thickness)
 For details see getThickness().
 
NChartLineDash getLineDash ()
 Dash of the crosshair.
 
void setLineDash (NChartLineDash lineDash)
 For details see getLineDash().
 
boolean shouldJumpToTouch ()
 Flag determining if the crosshair should move to the touch wherever the touch location is. More...
 
void setShouldJumpToTouch (boolean shouldJumpToTouch)
 For details see shouldJumpToTouch().
 
Bitmap getImage ()
 Image that is displaying in the crosshair. More...
 
void setImage (Bitmap image)
 For details see getImage().
 
PointF getImageOffset ()
 Offset in pixels of the image from the crosshair's center. More...
 
NChartCrosshairDelegate getDelegate ()
 Crosshair delegate. More...
 
void setDelegate (NChartCrosshairDelegate delegate)
 For details see getDelegate().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartObject
boolean isVisible ()
 Flag that determines if the object is visible or not. More...
 
void setVisible (boolean visible)
 For details see isVisible().
 
NChart getChart ()
 Chart the object belongs to. More...
 

Detailed Description

The NChartCrosshair class provides methods to control crosshairs - lines that are perpendicular to the axes and are to mark some position on the chart.

Single chart can have multiple crosshairs either connected to the chart points or free (with user defined coordinates).

Constructor & Destructor Documentation

com.nchart3d.NChart.NChartCrosshair.NChartCrosshair ( int  color,
float  thickness,
NChartPoint  targetPoint 
)
inline

Create crosshair with color, thickness and target point.

Parameters
color- color of the crosshair.
thickness- thickness of the crosshair.
targetPoint- tracking point of the crosshair.

Member Function Documentation

NChartCrosshairDelegate com.nchart3d.NChart.NChartCrosshair.getDelegate ( )
inline

Crosshair delegate.

For details see NChartCrosshairDelegate

Bitmap com.nchart3d.NChart.NChartCrosshair.getImage ( )
inline

Image that is displaying in the crosshair.

The default value is null.

PointF com.nchart3d.NChart.NChartCrosshair.getImageOffset ( )
inline

Offset in pixels of the image from the crosshair's center.

The default value is (0,0).

NChartPoint com.nchart3d.NChart.NChartCrosshair.getTargetPoint ( )
inline

Target point for the crosshair.

Use this property to set crosshair to track chart point.

float com.nchart3d.NChart.NChartCrosshair.getThickness ( )
inline

Thickness of the crosshair in pixels.

The default value is 1.

boolean com.nchart3d.NChart.NChartCrosshair.shouldJumpToTouch ( )
inline

Flag determining if the crosshair should move to the touch wherever the touch location is.

The default value is false. If this flag is true, all the touches are catched by the topmost crosshair (the one that was last added to the cartesian system of the chart). So no other user interactions like pan and point selection are possible in the chart.