iOS Charting Documentation - SciChart iOS Charts SDK v3.x

SCIAxisInfo

@interface SCIAxisInfo : NSObject <ISCIAxisInfoUpdatable>

Provides information on an axis hit test operation.

See

-[ISCIAxisInfoProvider getAxisInfo].
  • The axis id.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *axisId;

    Swift

    var axisId: String! { get set }
  • The axis title.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSString *axisTitle;

    Swift

    var axisTitle: String! { get set }
  • The attributed axis title.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) NSAttributedString *attributedAxisTitle;

    Swift

    @NSCopying var attributedAxisTitle: NSAttributedString! { get set }
  • The SCIAxisAlignment value.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) SCIAxisAlignment axisAlignment;

    Swift

    var axisAlignment: SCIAxisAlignment { get set }
  • The data value.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) id<ISCIComparable> dataValue;

    Swift

    var dataValue: ISCIComparable! { get set }
  • The data value formatted with ISCIAxisCore.textFormatting string.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) id<ISCIString> axisFormattedDataValue;

    Swift

    @NSCopying var axisFormattedDataValue: ISCIString! { get set }
  • The data value formatted with ISCIAxisCore.cursorTextFormatting string.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic) id<ISCIString> cursorFormattedDataValue;

    Swift

    @NSCopying var cursorFormattedDataValue: ISCIString! { get set }
  • Flag indicating whether the associated axis is horizontal axis.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL isHorizontal;

    Swift

    var isHorizontal: Bool { get set }
  • Flag indicating whether the associated axis is XAxis.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL isXAxis;

    Swift

    var isXAxis: Bool { get set }
  • Creates a new instance of SCIAxisInfo class.

    Declaration

    Objective-C

    - (instancetype)initWithAxis:(id<ISCIAxis>)axis;

    Parameters

    axis

    The parent axis

  • Updates this instance with latest value which does not depend on data value.

    Declaration

    Objective-C

    - (void)update;

    Swift

    func update()
  • Helper method which creates and updates SCIAxisInfo instance with latest information provided by axis.

    Declaration

    Objective-C

    + (SCIAxisInfo *)obtainFor:(id<ISCIAxis>)axis
                  andDataValue:(id<ISCIComparable>)dataValue;

    Parameters

    axis

    The ISCIAxis instance for which.

    dataValue

    The dataValue with which SCIAxisInfo should be updated.

    Return Value

    The SCIAxisInfo instance with latest information provided by axis.