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

SCIMeasureAnnotation

@interface SCIMeasureAnnotation : SCIMultiPointAnnotationBase

Defines a Measure annotation, a technical analysis tool placed on the chart using two anchor points which reports the price change, percentage change and bar count between them.

The annotation is drawn as a filled rectangle with arrowed centre lines, and is coloured according to whether the measurement is rising or falling.

  • Defines the SCIPenStyle used for the outline and centre lines when the second point is above the first.

    Declaration

    Objective-C

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

    Swift

    var growingStroke: SCIPenStyle { get set }
  • Defines the SCIBrushStyle used to fill the measured area when the second point is above the first.

    Declaration

    Objective-C

    @property (nonatomic, strong) SCIBrushStyle *_Nonnull growingFill;

    Swift

    var growingFill: SCIBrushStyle { get set }
  • Defines the SCIPenStyle used for the outline and centre lines when the second point is below the first.

    Declaration

    Objective-C

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

    Swift

    var decliningStroke: SCIPenStyle { get set }
  • Defines the SCIBrushStyle used to fill the measured area when the second point is below the first.

    Declaration

    Objective-C

    @property (nonatomic, strong) SCIBrushStyle *_Nonnull decliningFill;

    Swift

    var decliningFill: SCIBrushStyle { get set }
  • Defines the length of the centre line arrow heads in points.

    Declaration

    Objective-C

    @property (nonatomic) float arrowHeadLength;

    Swift

    var arrowHeadLength: Float { get set }
  • Defines the width of the centre line arrow heads in points.

    Declaration

    Objective-C

    @property (nonatomic) float arrowHeadWidth;

    Swift

    var arrowHeadWidth: Float { get set }
  • Defines the SCIFontStyle used by the measurement label.

    Note

    The label background is taken from the active stroke colour.

    Declaration

    Objective-C

    @property (nonatomic, strong) SCIFontStyle *_Nonnull labelStyle;

    Swift

    var labelStyle: SCIFontStyle { get set }
  • Defines the padding applied inside the measurement label.

    Declaration

    Objective-C

    @property (nonatomic) UIEdgeInsets labelPadding;

    Swift

    var labelPadding: UIEdgeInsets { get set }
  • Defines the factor applied to the price change to produce the scaled value shown in the label.

    Note

    Defaults to 100, which reports the change in basis-point style.

    Declaration

    Objective-C

    @property (nonatomic) double yValueScaleFactor;

    Swift

    var yValueScaleFactor: Double { get set }
  • Defines the value indicating whether the anchor points snap to whole candles.

    Note

    Only takes effect when the X-Axis is a category axis, where a data value is a bar index.

    Declaration

    Objective-C

    @property (nonatomic) BOOL snapToCandles;

    Swift

    var snapToCandles: Bool { get set }