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

SCITooltipLayoutHelper

@interface SCITooltipLayoutHelper : NSObject <ISCIAttachable, ISCIThemeable>

Defines the class which is used as helper while work with tooltip layout.




-initWithTooltipContainer:seriesTooltips:andUpdateTooltipCallback:

Creates a new instance of SCITooltipLayoutHelper class.

Declaration

Objective-C

- (nonnull instancetype)
    initWithTooltipContainer:(nonnull id<ISCITooltipContainer>)tooltipContainer
              seriesTooltips:
                  (nonnull SCIProjectionCollection<id<ISCISeriesTooltipCore>,
                                                   id<ISCIRenderableSeriesCore>>
                       *)seriesTooltips
    andUpdateTooltipCallback:(nonnull id<ISCISeriesTooltipCallback>)callback;

Swift

init(tooltipContainer: ISCITooltipContainer, seriesTooltips: SCIProjectionCollection<ISCISeriesTooltipCore, ISCIRenderableSeriesCore>, andUpdate callback: ISCISeriesTooltipCallback)

Parameters

`tooltipContainer`	Container to place tooltips into.
`seriesTooltips`	Tooltips which will be placed into passed in container.
`callback`	Callback which is used to update tooltips from behavior.




tooltipPosition

Defines the position of the tooltip related to the current touch point.

Declaration

Objective-C

@property (nonatomic) SCITooltipPosition tooltipPosition;

Swift

var tooltipPosition: SCITooltipPosition { get set }




-setObservableSeries:

Sets the observableSeries from the parent SCITooltipBehavior.

Declaration

Objective-C

- (void)setObservableSeries:
    (nonnull SCIObservableCollection<id<ISCIRenderableSeriesCore>> *)
        observableSeries;

Swift

func setObservableSeries(_ observableSeries: SCIObservableCollection<ISCIRenderableSeriesCore>)

-tryUpdateTooltipAt:
Tries to update series tooltip on screen.
Declaration
Objective-C

- (void)tryUpdateTooltipAt:(CGPoint)point;
Swift

func tryUpdateTooltip(at point: CGPoint)
Parameters

point

The [x, y] coordinates of the tooltip on screen.
-tryRemoveTooltip
Tries to remove series tooltip from screen.
Declaration
Objective-C

- (void)tryRemoveTooltip;
Swift

func tryRemoveTooltip()