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

ISCICalendarUnitDateFormatter

@protocol ISCICalendarUnitDateFormatter

Defines the protocol to a date formatter which is used by SCITradeChartAxisLabelFormatter.

  • Gets locale used by this date formatter.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSLocale *_Nonnull locale;

    Swift

    var locale: Locale { get }
  • Gets time zone used by this date formatter.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSTimeZone *_Nonnull timeZone;

    Swift

    var timeZone: TimeZone { get }
  • Tries to apply default format to underlying default NSDateFormatter.

    Declaration

    Objective-C

    - (void)tryApplyDefaultFormat:(nonnull NSString *)defaultFormat;

    Swift

    func tryApplyDefaultFormat(_ defaultFormat: String)

    Parameters

    defaultFormat

    Default format string to apply.

  • Formats date for the axis according to the specified calendarUnit.

    Declaration

    Objective-C

    - (nonnull id<ISCIString>)formatDate:(nonnull NSDate *)date
                        withCalendarUnit:(NSCalendarUnit)calendarUnit;

    Swift

    func formatDate(_ date: Date, with calendarUnit: NSCalendar.Unit) -> ISCIString

    Parameters

    date

    The date value to format.

    calendarUnit

    Calendar unit used while formatting date

    Return Value

    The formatted value.