iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x
SCIHitTestInfo
@interface SCIHitTestInfo : NSObject <ISCICleanable>
Defines a hit test info class which provides information on a series hit-test
operation.
-
The point where hit test is performed in pixels.
Declaration
Objective-C
@property (nonatomic) CGPoint hitTestPoint;
Swift
var hitTestPoint: CGPoint { get set }
-
The hit test radius in pixels.
Declaration
Objective-C
@property (nonatomic) float hitTestRadius;
Swift
var hitTestRadius: Float { get set }
-
The index of hit test point in associated
ISCIDataSeries
.Declaration
Objective-C
@property (nonatomic) NSInteger dataSeriesIndex;
Swift
var dataSeriesIndex: Int { get set }
-
The index of hit test point in associated
ISCISeriesRenderPassData
.Declaration
Objective-C
@property (nonatomic) NSInteger pointSeriesIndex;
Swift
var pointSeriesIndex: Int { get set }
-
The value indicating whether the
Hit-Test
operation was a hit or not.Declaration
Objective-C
@property (nonatomic) BOOL isHit;
Swift
var isHit: Bool { get set }
-
The value indicating whether the input point is between first and last series point or not.
Declaration
Objective-C
@property (nonatomic) BOOL isWithinDataBounds;
Swift
var isWithinDataBounds: Bool { get set }
-
The renderable series which was hit.
Declaration
Objective-C
@property (nonatomic, weak, nullable) id<ISCIRenderableSeries> hitRenderableSeries;
Swift
weak var hitRenderableSeries: ISCIRenderableSeries? { get set }
-
Gets the value indicating whether this
SCIHitTestInfo
is empty or not.Declaration
Objective-C
@property (nonatomic) BOOL isEmpty;
Swift
var isEmpty: Bool { get set }
-
Sets the hit test info values.
Declaration
Objective-C
- (void)setX:(float)x y:(float)y hitTestRadius:(float)hitTestRadius dataSeriesIndex:(NSInteger)dataSeriesIndex pointSeriesIndex:(NSInteger)pointSeriesIndex;
Swift
func setX(_ x: Float, y: Float, hitTestRadius: Float, dataSeriesIndex: Int, pointSeriesIndex: Int)
Parameters
x
The
x coordinate
of hit test point.y
The
y coordinate
of hit test point.hitTestRadius
The hit test radius.
dataSeriesIndex
The index of hit test point in associated
ISCIDataSeries
.pointSeriesIndex
The index of hit test point in associated
ISCISeriesRenderPassData
.