iOS Charting Documentation - SciChart iOS Charts SDK v3.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.
  • Defines the offset on which tooltip and the marker will be shifted in x and y directions.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) float offset;

    Swift

    var offset: Float { get set }
  • 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, assign, unsafe_unretained, readwrite)
        CGPoint customPointOffset;

    Swift

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

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCIPlacement markerPlacement;

    Swift

    var markerPlacement: SCIPlacement { get set }
  • Gets the SCITooltipPosition mode, to determine where to place tooltip relatively to the marker.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCITooltipPosition tooltipPosition;

    Swift

    var tooltipPosition: SCITooltipPosition { get set }
  • Gets the SCIPenStyle instance which will be used by SCICrossDrawableBehavior to tooltip marker.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCIPenStyle *tooltipPointMarkerPaintStyle;

    Swift

    var tooltipPointMarkerPaintStyle: SCIPenStyle! { get set }
  • Creates a new instance of SCITooltipModifier class.

    Declaration

    Objective-C

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

    Swift

    init!(crossDrawableBehavior: SCICrossDrawableBehavior!)

    Parameters

    crossDrawableBehavior

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

  • Creates a new instance of SCITooltipModifier class.

    Declaration

    Objective-C

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

    Swift

    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.