ArcGIS Runtime SDK for iOS: AGSBasemap.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSBasemap.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 #import <ArcGIS/AGSJSONSerializable.h>
30 #import <ArcGIS/AGSRemoteResource.h>
31 #import <ArcGIS/AGSAPIKeyResource.h>
32 
33 
34 
46 typedef {
47  AGSBasemapTypeImagery = 0,
48  AGSBasemapTypeImageryWithLabels = 1,
49  AGSBasemapTypeStreets = 2,
50  AGSBasemapTypeTopographic = 3,
51  AGSBasemapTypeTerrainWithLabels = 4,
52  AGSBasemapTypeLightGrayCanvas = 5,
53  AGSBasemapTypeNationalGeographic = 6,
54  AGSBasemapTypeOceans = 7,
55  AGSBasemapTypeOpenStreetMap = 8,
56  AGSBasemapTypeImageryWithLabelsVector = 9,
57  AGSBasemapTypeStreetsVector = 10,
58  AGSBasemapTypeTopographicVector = 11,
59  AGSBasemapTypeTerrainWithLabelsVector = 12,
60  AGSBasemapTypeLightGrayCanvasVector = 13,
61  AGSBasemapTypeNavigationVector = 14,
62  AGSBasemapTypeStreetsNightVector = 15,
63  AGSBasemapTypeStreetsWithReliefVector = 16,
64  AGSBasemapTypeDarkGrayCanvasVector = 17
65 };
66 
72 typedef NS_ENUM(NSInteger, AGSBasemapStyle) {
119 };
120 
121 @class AGSItem;
122 @class AGSLayer;
123 
136 
137 #pragma mark -
138 #pragma mark initializers
139 
140 -(instancetype)init;
141 
146 -(instancetype)initWithItem:(AGSItem*)item;
147 
152 -(instancetype)initWithBaseLayer:(AGSLayer*)layer;
153 
159 -(instancetype)initWithBaseLayers:(NSArray<AGSLayer*>*)baseLayers referenceLayers:(nullable NSArray<AGSLayer*>*)referenceLayers;
160 
166 -(nullable instancetype)initWithURL:(NSURL*)URL;
167 
173 - (instancetype)initWithStyle:(AGSBasemapStyle)style;
174 
178 +(instancetype)basemap;
179 
185 +(instancetype)basemapWithItem:(AGSItem*)item;
186 
191 +(instancetype)basemapWithBaseLayer:(AGSLayer*)layer;
192 
198 +(instancetype)basemapWithBaseLayers:(NSArray<AGSLayer*>*)baseLayers referenceLayers:(nullable NSArray<AGSLayer*>*)referenceLayers;
199 
205 +(nullable instancetype)basemapWithURL:(NSURL*)URL;
206 
212 + (instancetype)basemapWithStyle:(AGSBasemapStyle)style;
213 
214 #pragma mark -
215 #pragma mark properties
216 
220 @property (nonatomic, copy, readwrite) NSString *name;
221 
225 @property (nullable, nonatomic, strong, readonly) AGSItem *item;
226 
231 @property (nonatomic, strong, readonly) NSMutableArray<AGSLayer*> *baseLayers;
232 
237 @property (nonatomic, strong, readonly) NSMutableArray<AGSLayer*> *referenceLayers;
238 
239 #pragma mark -
240 #pragma mark methods
241 
242 @end
243 
245 
251 +(instancetype)darkGrayCanvasVectorBasemap ;
252 
258 +(instancetype)imageryBasemap ;
259 
265 +(instancetype)imageryWithLabelsBasemap ;
266 
272 +(instancetype)imageryWithLabelsVectorBasemap ;
273 
279 +(instancetype)lightGrayCanvasBasemap ;
280 
286 +(instancetype)lightGrayCanvasVectorBasemap ;
287 
293 +(instancetype)nationalGeographicBasemap ;
294 
300 +(instancetype)navigationVectorBasemap ;
301 
306 +(instancetype)oceansBasemap ;
307 
312 +(instancetype)openStreetMapBasemap ;
313 
318 +(instancetype)streetsBasemap ;
319 
324 +(instancetype)streetsNightVectorBasemap ;
325 
330 +(instancetype)streetsVectorBasemap ;
331 
336 +(instancetype)streetsWithReliefVectorBasemap ;
337 
342 +(instancetype)terrainWithLabelsVectorBasemap ;
343 
348 +(instancetype)terrainWithLabelsBasemap ;
349 
354 +(instancetype)topographicBasemap ;
355 
360 +(instancetype)topographicVectorBasemap ;
361 
362 @end
363 
364 
AGSBasemapStyle
Definition: AGSBasemap.h:72
@ AGSBasemapStyleOSMLightGrayBase
Definition: AGSBasemap.h:113
@ AGSBasemapStyleArcGISColoredPencil
Definition: AGSBasemap.h:96
@ AGSBasemapStyleArcGISChartedTerritory
Definition: AGSBasemap.h:95
@ AGSBasemapStyleArcGISNova
Definition: AGSBasemap.h:97
@ AGSBasemapStyleOSMLightGrayLabels
Definition: AGSBasemap.h:114
@ AGSBasemapStyleArcGISLightGray
Definition: AGSBasemap.h:76
@ AGSBasemapStyleArcGISStreetsNight
Definition: AGSBasemap.h:85
@ AGSBasemapStyleOSMStandard
Definition: AGSBasemap.h:107
@ AGSBasemapStyleArcGISStreetsRelief
Definition: AGSBasemap.h:86
@ AGSBasemapStyleOSMStreets
Definition: AGSBasemap.h:110
@ AGSBasemapStyleArcGISOceans
Definition: AGSBasemap.h:88
@ AGSBasemapStyleArcGISStreetsReliefBase
Definition: AGSBasemap.h:103
@ AGSBasemapStyleOSMStreetsReliefBase
Definition: AGSBasemap.h:118
@ AGSBasemapStyleOSMLightGray
Definition: AGSBasemap.h:112
@ AGSBasemapStyleArcGISImageryLabels
Definition: AGSBasemap.h:75
@ AGSBasemapStyleOSMStandardRelief
Definition: AGSBasemap.h:108
@ AGSBasemapStyleOSMStandardReliefBase
Definition: AGSBasemap.h:109
@ AGSBasemapStyleArcGISMidcentury
Definition: AGSBasemap.h:99
@ AGSBasemapStyleArcGISTerrain
Definition: AGSBasemap.h:91
@ AGSBasemapStyleArcGISOceansBase
Definition: AGSBasemap.h:89
@ AGSBasemapStyleArcGISImagery
Definition: AGSBasemap.h:73
@ AGSBasemapStyleArcGISDarkGrayLabels
Definition: AGSBasemap.h:81
@ AGSBasemapStyleArcGISTerrainBase
Definition: AGSBasemap.h:92
@ AGSBasemapStyleArcGISHillshadeLight
Definition: AGSBasemap.h:101
@ AGSBasemapStyleArcGISChartedTerritoryBase
Definition: AGSBasemap.h:105
@ AGSBasemapStyleArcGISNewspaper
Definition: AGSBasemap.h:100
@ AGSBasemapStyleArcGISModernAntique
Definition: AGSBasemap.h:98
@ AGSBasemapStyleArcGISTopographic
Definition: AGSBasemap.h:87
@ AGSBasemapStyleArcGISHillshadeDark
Definition: AGSBasemap.h:102
@ AGSBasemapStyleArcGISOceansLabels
Definition: AGSBasemap.h:90
@ AGSBasemapStyleArcGISCommunity
Definition: AGSBasemap.h:94
@ AGSBasemapStyleOSMDarkGrayBase
Definition: AGSBasemap.h:116
@ AGSBasemapStyleArcGISDarkGrayBase
Definition: AGSBasemap.h:80
@ AGSBasemapStyleArcGISStreets
Definition: AGSBasemap.h:84
@ AGSBasemapStyleArcGISLightGrayLabels
Definition: AGSBasemap.h:78
@ AGSBasemapStyleArcGISModernAntiqueBase
Definition: AGSBasemap.h:106
@ AGSBasemapStyleArcGISTopographicBase
Definition: AGSBasemap.h:104
@ AGSBasemapStyleArcGISTerrainDetail
Definition: AGSBasemap.h:93
@ AGSBasemapStyleOSMDarkGrayLabels
Definition: AGSBasemap.h:117
@ AGSBasemapStyleArcGISImageryStandard
Definition: AGSBasemap.h:74
@ AGSBasemapStyleArcGISLightGrayBase
Definition: AGSBasemap.h:77
@ AGSBasemapStyleOSMStreetsRelief
Definition: AGSBasemap.h:111
@ AGSBasemapStyleArcGISDarkGray
Definition: AGSBasemap.h:79
@ AGSBasemapStyleArcGISNavigation
Definition: AGSBasemap.h:82
@ AGSBasemapStyleOSMDarkGray
Definition: AGSBasemap.h:115
@ AGSBasemapStyleArcGISNavigationNight
Definition: AGSBasemap.h:83
Definition: AGSBasemap.h:244
A basemap for a map or a scene.
Definition: AGSBasemap.h:135
NSMutableArray< AGSLayer * > * referenceLayers
Definition: AGSBasemap.h:237
instancetype basemap()
NSString * name
Definition: AGSBasemap.h:220
instancetype init()
NSMutableArray< AGSLayer * > * baseLayers
Definition: AGSBasemap.h:231
AGSItem * item
Definition: AGSBasemap.h:225
Object representing a unit of content.
Definition: AGSItem.h:43
An abstract base class for all layers.
Definition: AGSLayer.h:201
A base class for loadables.
Definition: AGSLoadableBase.h:45
An interface for getting and setting the API key of an object.
Definition: AGSAPIKeyResource.h:36
A protocol to convert objects to and from JSON.
Definition: AGSJSONSerializable.h:38
A protocol adopted by classes that access remote network resources that have the potential to be secu...
Definition: AGSRemoteResource.h:40