WeatherKit · IOS API REFERENCE

HistoricalComparisons

struct · iOS 18.0+ · SDK 27.1

struct HistoricalComparisons

A structure that represents the weather condition comparisons for a specific location. It's a list of comparisons between current readings and historical averages. The list is ordered by significance of deviation.

Members (7)

get · iOS 18.0+

startIndex

TypeScript

get startIndex(): number

Swift declaration

var startIndex: HistoricalComparisons.Index { get }

The start index for the historical comparisons.

get · iOS 18.0+

comparisons

TypeScript

get comparisons(): Array<HistoricalComparison>

Swift declaration

var comparisons: [HistoricalComparison]

A list of comparisons between current readings and historical averages, ordered by significance of deviation.

set · iOS 18.0+

comparisons

TypeScript

set comparisons(value: Array<HistoricalComparison>)

Swift declaration

var comparisons: [HistoricalComparison]

A list of comparisons between current readings and historical averages, ordered by significance of deviation.

get · iOS 18.0+

endIndex

TypeScript

get endIndex(): number

Swift declaration

var endIndex: HistoricalComparisons.Index { get }

The end index for the historical comparisons.

get · iOS 18.0+

metadata

TypeScript

get metadata(): WeatherMetadata

Swift declaration

var metadata: WeatherMetadata

Descriptive information about the weather comparisons data.

set · iOS 18.0+

metadata

TypeScript

set metadata(value: WeatherMetadata)

Swift declaration

var metadata: WeatherMetadata

Descriptive information about the weather comparisons data.

subscript · iOS 18.0+

subscript

TypeScript

subscript(position: number): HistoricalComparison

Swift declaration

subscript(position: HistoricalComparisons.Index) -> HistoricalComparisons.Element { get }

The historical comparison at the provided index.

Skipped declarations

No declarations were skipped in this snapshot.

All WeatherKit types →