Core Plot (iOS and tvOS)
Cocoa plotting framework for macOS, iOS, and tvOS
CPTCalendarFormatter Class Reference

A number formatter that converts calendar intervals to dates. More...

#import <CPTCalendarFormatter.h>

+ Inheritance diagram for CPTCalendarFormatter:
+ Collaboration diagram for CPTCalendarFormatter:

Public Instance Methods

Initialization
(nonnull instancetype) - initWithDateFormatter:
 Initializes new instance with the date formatter passed. More...
 
(nullable instancetype) - initWithCoder:
 Returns an object initialized from data in a given unarchiver. More...
 
(nonnull instancetype) - init [implementation]
 Initializes a newly allocated CPTCalendarFormatter object with a default date formatter. The default formatter uses NSDateFormatterMediumStyle for dates and times. More...
 
Formatting
(nullable NSString *) - stringForObjectValue: [implementation]
 Converts decimal number for the time into a date string. Uses the date formatter to do the conversion. Conversions are relative to the reference date, unless it is nil, in which case the standard reference date of 1 January 2001, GMT is used. More...
 
- Public Instance Methods inherited from NSObject
(Class- classForCoder
 
(id- copy
 
(void) - dealloc
 
(void) - finalize
 
(id- init
 
(id- mutableCopy
 
- Public Instance Methods inherited from <NSObject>
(NSString *) - description
 
(NSUInteger- hash
 
(BOOL- isEqual:
 
- Public Instance Methods inherited from <NSCoding>
(id- initWithCoder:
 
(void) - encodeWithCoder:
 
- Public Instance Methods inherited from <NSCopying>
(id- copyWithZone:
 

Properties

NSDateFormatterdateFormatter
 The date formatter used to generate strings from date calculations. More...
 
NSDatereferenceDate
 Date from which time intervals are computed. If nil, the standard reference date (1 January 2001, GMT) is used. More...
 
NSCalendarreferenceCalendar
 Calendar which is used for date calculations. If nil, the current calendar is used. More...
 
NSCalendarUnit referenceCalendarUnit
 Calendar unit which is incremented in the date calculation. If zero (0), the date is incremented. More...
 

Additional Inherited Members

- Public Class Methods inherited from NSObject
(id+ alloc
 
(Class+ class
 
(void) + initialize
 
(void) + load
 
(id+ new
 

Detailed Description

A number formatter that converts calendar intervals to dates.

Useful for formatting labels on an axis. The numerical scale of the plot space will be used to increment the specified calendar unit. For example, with a majorIntervalLength of one (1) and a referenceCalendarUnit of NSMonthCalendarUnit, successive months will be displayed on the axis. Axis labels can be directly generated by setting a CPTCalendarFormatter as the labelFormatter and/or minorTickLabelFormatter .

Method Documentation

◆ init

- (nonnull instancetype) init
implementation

Initializes a newly allocated CPTCalendarFormatter object with a default date formatter. The default formatter uses NSDateFormatterMediumStyle for dates and times.

Returns
The initialized object.

◆ initWithCoder:

- (nullable instancetype) initWithCoder: (nonnull NSCoder *)  coder

Returns an object initialized from data in a given unarchiver.

Parameters
coderAn unarchiver object.
Returns
An object initialized from data in a given unarchiver.

◆ initWithDateFormatter:

- (nonnull instancetype) initWithDateFormatter: (nullable NSDateFormatter *)  aDateFormatter

Initializes new instance with the date formatter passed.

Parameters
aDateFormatterThe date formatter.
Returns
The new instance.

◆ stringForObjectValue:

- (nullable NSString *) stringForObjectValue: (nullable id coordinateValue
implementation

Converts decimal number for the time into a date string. Uses the date formatter to do the conversion. Conversions are relative to the reference date, unless it is nil, in which case the standard reference date of 1 January 2001, GMT is used.

Parameters
coordinateValueThe time value.
Returns
The date string.

Property Documentation

◆ dateFormatter

- (nullable NSDateFormatter *) dateFormatter
readwritenonatomicstrong

The date formatter used to generate strings from date calculations.

◆ referenceCalendar

- (nullable NSCalendar *) referenceCalendar
readwritenonatomiccopy

Calendar which is used for date calculations. If nil, the current calendar is used.

◆ referenceCalendarUnit

- (NSCalendarUnit) referenceCalendarUnit
readwritenonatomicassign

Calendar unit which is incremented in the date calculation. If zero (0), the date is incremented.

◆ referenceDate

- (nullable NSDate *) referenceDate
readwritenonatomiccopy

Date from which time intervals are computed. If nil, the standard reference date (1 January 2001, GMT) is used.


The documentation for this class was generated from the following files: