iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCITooltipModifier

@interface SCITooltipModifier : SCITooltipModifierBase

The SCITooltipModifier provides a touch-over tooltip to a chart, outputting a single SCISeriesInfo object to bind to which updates as the touch moves over data-points.

Note

Add to a SCIChartSurface and set ISCIChartModifier.isEnabled toYES to enable this behaviour.

See

SCICursorModifier.

See

SCIRolloverModifier.

offset
Defines the offset on which tooltip and the marker will be shifted in x and y directions.
Declaration
Objective-C

@property (nonatomic) CGFloat offset;
Swift

var offset: CGFloat { get set }
customPointOffset
Gets the CGPoint value which will replace offset property and will be used to shift tooltip and the marker in custom x and y directions.
Declaration
Objective-C

@property (nonatomic) CGPoint customPointOffset;
Swift

var customPointOffset: CGPoint { get set }
markerPlacement
Gets the SCIPlacement mode, to determine where to place tooltip and the marker relatively to the Hit-test point.
Declaration
Objective-C

@property (nonatomic) SCIPlacement markerPlacement;
Swift

var markerPlacement: SCIPlacement { get set }
tooltipPosition
Gets the SCITooltipPosition mode, to determine where to place tooltip relatively to the marker.
Declaration
Objective-C

@property (nonatomic) SCITooltipPosition tooltipPosition;
Swift

var tooltipPosition: SCITooltipPosition { get set }




tooltipPointMarkerPaintStyle

Gets the SCIPenStyle instance which will be used by SCICrossDrawableBehavior to tooltip marker.

Declaration

Objective-C

@property (nonatomic, strong) SCIPenStyle *_Nonnull tooltipPointMarkerPaintStyle;

Swift

var tooltipPointMarkerPaintStyle: SCIPenStyle { get set }

-init
Creates a new instance of SCITooltipModifier class.
Declaration
Objective-C

- (nonnull instancetype)init;
Swift

convenience init()
-initWithCrossDrawableBehavior:
Creates a new instance of SCITooltipModifier class.
Declaration
Objective-C

- (nonnull instancetype)initWithCrossDrawableBehavior: (nonnull SCICrossDrawableBehavior *)crossDrawableBehavior;
Swift

convenience init(crossDrawableBehavior: SCICrossDrawableBehavior)
Parameters

crossDrawableBehavior

The SCIDrawableBehavior instance which will be use to show marker which will identify what point will be Hit-tested.




-initWithCrossDrawableBehavior:andTooltipContainer:

Creates a new instance of SCITooltipModifier class.

Declaration

Objective-C

- (nonnull instancetype)
    initWithCrossDrawableBehavior:
        (nonnull SCICrossDrawableBehavior *)crossDrawableBehavior
              andTooltipContainer:
                  (nonnull id<ISCITooltipContainer>)tooltipContainer;

Swift

convenience init(crossDrawableBehavior: SCICrossDrawableBehavior, andTooltipContainer tooltipContainer: ISCITooltipContainer)

Parameters

`crossDrawableBehavior`	The `SCIDrawableBehavior` instance which will be use to show marker which will identify what point will be Hit-tested.
`tooltipContainer`	The tooltip container.




-initWithTooltipBehavior:crossDrawableBehavior:

Creates a new instance of SCITooltipModifier class.

Declaration

Objective-C

- (nonnull instancetype)
    initWithTooltipBehavior:(nonnull SCITooltipBehaviorBase *)tooltipBehavior
      crossDrawableBehavior:
          (nonnull SCICrossDrawableBehavior *)crossDrawableBehavior;

Swift

init(tooltipBehavior: SCITooltipBehaviorBase<ISCIChartModifier>, crossDrawableBehavior: SCICrossDrawableBehavior)

Parameters

`tooltipBehavior`	The `SCITooltipBehavior` which will be associated with this modifier.
`crossDrawableBehavior`	The `SCIDrawableBehavior` instance which will be use to show marker which will identify what point will be Hit-tested.