summaryrefslogtreecommitdiff
path: root/platform/darwin/include/MGLStyle.h
blob: 798bc1cf1211cc0ee4ecd26bb433c3d45f120f17 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
#import <Foundation/Foundation.h>

#import "MGLTypes.h"

NS_ASSUME_NONNULL_BEGIN

/**
 A version number identifying the latest released version of the suite of default styles provided by Mapbox. This version number may be passed into one of the “StyleURLWithVersion” class methods of MGLStyle.
 
 The value of this constant is current as of the date on which this SDK was published. Consult the <a href="https://www.mapbox.com/api-documentation/#styles">Mapbox Styles API documentation</a> for the most up-to-date style versioning information.
 
 @warning The value of this constant may change in a future release of the SDK. If you use any feature that depends on a specific implementation detail in a default style, you may use the current value of this constant or the underlying style URL, but do not use the constant itself. Such implementation details may change significantly from version to version.
 */
static const NSInteger MGLStyleCurrentVersion = 9;

/**
 A collection of convenience methods for creating style URLs of default styles provided by Mapbox.
 */
@interface MGLStyle : NSObject

/**
 Returns the URL to version 8 of the Streets style.
 
 Mapbox Streets is a complete base map that balances nature, commerce, and infrastructure.
 */
+ (NSURL *)streetsStyleURL __attribute__((deprecated("Use -streetsStyleURLWithVersion:.")));

/**
 Returns the URL to the given version of the Streets style.
 
 Mapbox Streets is a complete base map that balances nature, commerce, and infrastructure.
 
 @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`.
 */
+ (NSURL *)streetsStyleURLWithVersion:(NSInteger)version;

/**
 Returns the URL to version 8 of the Emerald style.
 
 Mapbox Emerald is a versatile style with emphasis on road networks and public transportation.
 */
+ (NSURL *)emeraldStyleURL __attribute__((deprecated("Use <mapbox://styles/mapbox/emerald-v8>.")));

/**
 Returns the URL to the given version of the Outdoors style.
 
 Mapbox Outdoors is a rugged style that emphasizes physical terrain and outdoor activities.
 
 @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`.
 */
+ (NSURL *)outdoorsStyleURLWithVersion:(NSInteger)version;

/**
 Returns the URL to version 8 of the Light style.
 
 Mapbox Light is a subtle, light-colored backdrop for data visualizations.
 */
+ (NSURL *)lightStyleURL __attribute__((deprecated("Use -lightStyleURLWithVersion:.")));

/**
 Returns the URL to the given version of the Light style.
 
 Mapbox Light is a subtle, light-colored backdrop for data visualizations.
 
 @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`.
 */
+ (NSURL *)lightStyleURLWithVersion:(NSInteger)version;

/**
 Returns the URL to version 8 of the Dark style.
 
 Mapbox Dark is a subtle, dark-colored backdrop for data visualizations.
 */
+ (NSURL *)darkStyleURL __attribute__((deprecated("Use -darkStyleURLWithVersion:.")));

/**
 Returns the URL to the given version of the Dark style.
 
 Mapbox Dark is a subtle, dark-colored backdrop for data visualizations.
 
 @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`.
 */
+ (NSURL *)darkStyleURLWithVersion:(NSInteger)version;

/**
 Returns the URL to version 8 of the Satellite style.
 
 Mapbox Satellite is a beautiful global satellite and aerial imagery layer.
 */
+ (NSURL *)satelliteStyleURL __attribute__((deprecated("Use -satelliteStyleURLWithVersion:.")));

/**
 Returns the URL to the given version of the Satellite style.
 
 Mapbox Satellite is a beautiful global satellite and aerial imagery layer.
 
 @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`.
 */
+ (NSURL *)satelliteStyleURLWithVersion:(NSInteger)version;

/**
 Returns the URL to version 8 of the Hybrid style.
 
 Mapbox Hybrid combines the global satellite and aerial imagery of Mapbox Satellite with unobtrusive labels.
 */
+ (NSURL *)hybridStyleURL __attribute__((deprecated("Use -hybridStyleURLWithVersion:.")));

/**
 Returns the URL to the given version of the Hybrid style.
 
 Mapbox Hybrid combines the global satellite and aerial imagery of Mapbox Satellite with unobtrusive labels.
 
 @param version The style’s latest released version. The current version is given by `MGLStyleCurrentVersion`.
 */
+ (NSURL *)hybridStyleURLWithVersion:(NSInteger)version;

- (instancetype)init NS_UNAVAILABLE;

@end

NS_ASSUME_NONNULL_END