iOS Charting Documentation - SciChart iOS Charts SDK v3.x

SCITooltipModifierStyleProtocol

@protocol SCITooltipModifierStyleProtocol <SCIStyleProtocol, NSCopying>

The SCITooltipModifierStyleBase protocol.

Note

Provides common properties for styling tooltip modifiers
  • Changes style of head text in toolTipView. Head text by default displays data series name

    See

    SCITextFormattingStyle

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) SCIFontStyle *headLineStyle;

    Swift

    @NSCopying var headLineStyle: SCIFontStyle! { get set }
  • Changes style of data text in toolTipView.

    Note

    By default data text is hit test results

    See

    SCITextFormattingStyle

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) SCIFontStyle *dataStyle;

    Swift

    @NSCopying var dataStyle: SCIFontStyle! { get set }
  • Deprecated

    Changes number formatter for values. Default is nil.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSNumberFormatter *numberFormatter;

    Swift

    var numberFormatter: NumberFormatter! { get set }
  • Deprecated

    Changes date formatter for values. Default is nil.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) NSDateFormatter *dateTimeFormatter;

    Swift

    var dateTimeFormatter: DateFormatter! { get set }
  • @abstract This block is used for additional customization of toltip view

    Note

    Type: typedef void (^SCITooltipViewSetupBlock) (SCITooltipView * view);

    See

    SCITooltipViewSetupBlock

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) SCITooltipViewSetupBlock tooltipViewSetup;

    Swift

    var tooltipViewSetup: SCITooltipViewSetupBlock! { get set }
  • Changes limit of size of toolTipView.

    Note

    Default is CGSizeMake(NaN, NaN) which means size is unlimited and will be based on content

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGSize tooltipSize;

    Swift

    var tooltipSize: CGSize { get set }
  • Defines distance in pixels from tooltip view border to internal content view (in fact distance from border to text inside tooltip view)

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float contentPadding;

    Swift

    var contentPadding: Float { get set }
  • Changes aligment mode of toolTipView.

    Note

    Tooltip alignment defines where tooltip view will be placed relative to hit test point

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        SCITooltipViewAlignmentMode tooltipAlignment;

    Swift

    var tooltipAlignment: SCITooltipViewAlignmentMode { get set }
  • Changes distance between targetMarker and toolTipView. Default is 5.0.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float alignmentMargin;

    Swift

    var alignmentMargin: Float { get set }
  • Changes colour mode of hit test. Default is SCITooltipColorMode_SeriesColorToDataView.

    See

    SCITooltipColorMode

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) SCITooltipColorMode colorMode;

    Swift

    var colorMode: SCITooltipColorMode { get set }
  • Changes background colour of toolTipView. Default is darkGrayColor.

    Note

    If property colorMode = SCITooltipColorMode_SeriesColor this color will be ovewtitten by series color

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) UIColor *tooltipColor;

    Swift

    var tooltipColor: UIColor! { get set }
  • Changes border colour of toolTipView. Default is lightGrayColor.

    Note

    If property colorMode = SCITooltipColorMode_SeriesColor this color will be ovewtitten by series color

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) UIColor *tooltipBorderColor;

    Swift

    var tooltipBorderColor: UIColor! { get set }
  • Changes border width of toolTipView. Default is 2.0f.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float tooltipBorderWidth;

    Swift

    var tooltipBorderWidth: Float { get set }
  • Changes corner radius of toolTipView. Default is 0.0f.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float tooltipCornerRadius;

    Swift

    var tooltipCornerRadius: Float { get set }
  • Changes opacity of toolTipView. Default is 0.7f.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float tooltipOpacity;

    Swift

    var tooltipOpacity: Float { get set }
  • Changes shadow offset of toolTipView. Default is CGSizeMake(-5, 10).

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) CGSize tooltipShadowOffset;

    Swift

    var tooltipShadowOffset: CGSize { get set }
  • Changes shadow radius of toolTipView. Default is 3.0f.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float tooltipShadowRadius;

    Swift

    var tooltipShadowRadius: Float { get set }
  • Changes shadow opacity of toolTipView. Default is 0.7f.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float tooltipShadowOpacity;

    Swift

    var tooltipShadowOpacity: Float { get set }
  • Defines is modifier tooltip is visible. Default is true

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) _Bool showTooltip;

    Swift

    var showTooltip: Bool { get set }