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

SCIPieChartTooltipModifier

@interface SCIPieChartTooltipModifier : SCIPieChartTooltipModifierBase

The SCIPieChartTooltipModifier provides a touch-over tooltip to a pie chart, outputting a single SCIPieSeriesInfo object to bind to which updates as the touch moves over segments. Add to a SCIPieChartSurface and set SCIPieChartTooltipModifier.isEnabled to YES to enable this behaviour.

  • Gets or sets the offset on which tooltip and the marker will be shifted in x and y directions.

    Declaration

    Objective-C

    @property (nonatomic) float offset;

    Swift

    var offset: Float { get set }
  • Gets or sets the CGPoint value which will replace SCIPieChartTooltipModifier.offset 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 }
  • Gets or sets 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 }
  • Gets or sets 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 }
  • Gets the SCIPenStyle instance which will be used by SCIPieChartCrossDrawableBehavior to tooltip marker.

    Declaration

    Objective-C

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

    Swift

    var tooltipPointMarkerPaintStyle: SCIPenStyle { get }
  • Creates a new instance of SCIPieChartTooltipModifier class.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    convenience init()
  • Creates a new instance of SCIPieChartTooltipModifier class.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCrossDrawableBehavior:
        (nonnull SCIPieChartCrossDrawableBehavior *)crossDrawableBehavior;

    Swift

    convenience init(crossDrawableBehavior: SCIPieChartCrossDrawableBehavior)

    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 SCIPieChartTooltipModifier class.

    Declaration

    Objective-C

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

    Swift

    convenience init(crossDrawableBehavior: SCIPieChartCrossDrawableBehavior, 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.

  • Creates a new instance of SCIPieChartTooltipModifier class.

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithTooltipBehavior:
            (nonnull SCIPieChartTooltipBehavior *)tooltipBehavior
          crossDrawableBehavior:
              (nonnull SCIPieChartCrossDrawableBehavior *)crossDrawableBehavior;

    Swift

    init(tooltipBehavior: SCIPieChartTooltipBehavior, crossDrawableBehavior: SCIPieChartCrossDrawableBehavior)

    Parameters

    tooltipBehavior

    The SCIPieChartTooltipBehavior which will be associated with this modifier.

    crossDrawableBehavior

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