YMKMasstransitElevationData

Warning

This feature is available in the Full MapKit SDK version

@interface YMKMasstransitElevationData : NSObject

Information of elevation gain in loss in a fitness section

Summary

Class methods

+ (nonnull YMKMasstransitElevationData *)elevationDataWithTotalAscent:(nonnull YMKLocalizedValue *)totalAscent
                                                         totalDescent:(nonnull YMKLocalizedValue *)totalDescent
                                                                steps:(nullable YMKLocalizedValue *)steps
                                                         kilocalories:(nonnull YMKLocalizedValue *)kilocalories
                                                      inclineSections:(nonnull NSArray<YMKMasstransitInclineSection *> *)inclineSections
                                                    elevationSegments:(nonnull NSArray<YMKMasstransitElevationPoint *> *)elevationSegments;

Properties

@property (nonatomic, readonly, nonnull) YMKLocalizedValue *totalAscent;
Total ascent in meters

@property (nonatomic, readonly, nonnull) YMKLocalizedValue *totalDescent;
Total descent in meters

@property (nonatomic, readonly, nullable) YMKLocalizedValue *steps;
The number of steps required to cover the distance for an average person

Optional field, can be nil

@property (nonatomic, readonly, nonnull) YMKLocalizedValue *kilocalories;
The number of kilocalories consumed by an average person to cover the distance

@property (nonatomic, readonly, nonnull)
    NSArray<YMKMasstransitInclineSection *> *inclineSections;

List of sections with notable incline

@property (nonatomic, readonly, nonnull)
    NSArray<YMKMasstransitElevationPoint *> *elevationSegments;

List of elevation for each point of the section polyline

Class methods

elevationDataWithTotalAscent:totalDescent:steps:kilocalories:inclineSections:elevationSegments:

+ (nonnull YMKMasstransitElevationData *)elevationDataWithTotalAscent:(nonnull YMKLocalizedValue *)totalAscent
                                                         totalDescent:(nonnull YMKLocalizedValue *)totalDescent
                                                                steps:(nullable YMKLocalizedValue *)steps
                                                         kilocalories:(nonnull YMKLocalizedValue *)kilocalories
                                                      inclineSections:(nonnull NSArray<YMKMasstransitInclineSection *> *)inclineSections
                                                    elevationSegments:(nonnull NSArray<YMKMasstransitElevationPoint *> *)elevationSegments;


Properties

totalAscent

@property (nonatomic, readonly, nonnull) YMKLocalizedValue *totalAscent;

Total ascent in meters


totalDescent

@property (nonatomic, readonly, nonnull) YMKLocalizedValue *totalDescent;

Total descent in meters


steps

@property (nonatomic, readonly, nullable) YMKLocalizedValue *steps;

The number of steps required to cover the distance for an average person

Optional field, can be nil.


kilocalories

@property (nonatomic, readonly, nonnull) YMKLocalizedValue *kilocalories;

The number of kilocalories consumed by an average person to cover the distance


inclineSections

@property (nonatomic, readonly, nonnull)
    NSArray<YMKMasstransitInclineSection *> *inclineSections;

List of sections with notable incline


elevationSegments

@property (nonatomic, readonly, nonnull)
    NSArray<YMKMasstransitElevationPoint *> *elevationSegments;

List of elevation for each point of the section polyline