ArcGIS Runtime SDK for iOS: AGSBasemap.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSBasemap.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 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 
43 typedef NS_ENUM(NSInteger, AGSBasemapType) {
62 };
63 
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 
245 +(instancetype)darkGrayCanvasVectorBasemap;
246 
250 +(instancetype)imageryBasemap;
251 
255 +(instancetype)imageryWithLabelsBasemap;
256 
260 +(instancetype)imageryWithLabelsVectorBasemap;
261 
265 +(instancetype)lightGrayCanvasBasemap;
266 
270 +(instancetype)lightGrayCanvasVectorBasemap;
271 
275 +(instancetype)nationalGeographicBasemap;
276 
280 +(instancetype)navigationVectorBasemap;
281 
285 +(instancetype)oceansBasemap;
286 
290 +(instancetype)openStreetMapBasemap;
291 
295 +(instancetype)streetsBasemap;
296 
300 +(instancetype)streetsNightVectorBasemap;
301 
305 +(instancetype)streetsVectorBasemap;
306 
310 +(instancetype)streetsWithReliefVectorBasemap;
311 
315 +(instancetype)terrainWithLabelsVectorBasemap ;
316 
320 +(instancetype)terrainWithLabelsBasemap;
321 
325 +(instancetype)topographicBasemap;
326 
330 +(instancetype)topographicVectorBasemap;
331 
332 @end
333 
334 
AGSBasemapType
Definition: AGSBasemap.h:43
@ AGSBasemapTypeStreetsNightVector
Definition: AGSBasemap.h:59
@ AGSBasemapTypeTopographic
Definition: AGSBasemap.h:47
@ AGSBasemapTypeDarkGrayCanvasVector
Definition: AGSBasemap.h:61
@ AGSBasemapTypeNavigationVector
Definition: AGSBasemap.h:58
@ AGSBasemapTypeLightGrayCanvasVector
Definition: AGSBasemap.h:57
@ AGSBasemapTypeStreets
Definition: AGSBasemap.h:46
@ AGSBasemapTypeNationalGeographic
Definition: AGSBasemap.h:50
@ AGSBasemapTypeLightGrayCanvas
Definition: AGSBasemap.h:49
@ AGSBasemapTypeTopographicVector
Definition: AGSBasemap.h:55
@ AGSBasemapTypeTerrainWithLabels
Definition: AGSBasemap.h:48
@ AGSBasemapTypeImageryWithLabels
Definition: AGSBasemap.h:45
@ AGSBasemapTypeImagery
Definition: AGSBasemap.h:44
@ AGSBasemapTypeTerrainWithLabelsVector
Definition: AGSBasemap.h:56
@ AGSBasemapTypeOceans
Definition: AGSBasemap.h:51
@ AGSBasemapTypeImageryWithLabelsVector
Definition: AGSBasemap.h:53
@ AGSBasemapTypeOpenStreetMap
Definition: AGSBasemap.h:52
@ AGSBasemapTypeStreetsVector
Definition: AGSBasemap.h:54
@ AGSBasemapTypeStreetsWithReliefVector
Definition: AGSBasemap.h:60
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
A basemap for a map or a scene.
Definition: AGSBasemap.h:135
instancetype lightGrayCanvasVectorBasemap()
instancetype imageryWithLabelsVectorBasemap()
instancetype terrainWithLabelsBasemap()
instancetype topographicBasemap()
instancetype imageryWithLabelsBasemap()
instancetype navigationVectorBasemap()
instancetype streetsBasemap()
instancetype streetsNightVectorBasemap()
NSMutableArray< AGSLayer * > * referenceLayers
Definition: AGSBasemap.h:237
instancetype streetsVectorBasemap()
instancetype nationalGeographicBasemap()
instancetype basemap()
instancetype oceansBasemap()
NSString * name
Definition: AGSBasemap.h:220
instancetype init()
instancetype lightGrayCanvasBasemap()
instancetype topographicVectorBasemap()
instancetype terrainWithLabelsVectorBasemap()
instancetype streetsWithReliefVectorBasemap()
instancetype imageryBasemap()
NSMutableArray< AGSLayer * > * baseLayers
Definition: AGSBasemap.h:231
instancetype openStreetMapBasemap()
instancetype darkGrayCanvasVectorBasemap()
AGSItem * item
Definition: AGSBasemap.h:225
Object representing a unit of content.
Definition: AGSItem.h:44
An abstract base class for all layers.
Definition: AGSLayer.h:194
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