AGSMap.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSGeoModel.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSImage.h>
#import <ArcGIS/AGSColor.h>
#import <ArcGIS/AGSBasemap.h>
#import <ArcGIS/AGSCancelable.h>
 
@class AGSPortal;
@class AGSPortalFolder;
@class AGSViewpoint;
@class AGSItem;
@class AGSOfflineSettings;
@class AGSSpatialReference;
@class AGSUtilityNetwork;
@class AGSUtilityNamedTraceConfiguration;
@class AGSEnvelope;
 //Required for Globals API doc
 
@interface AGSMap : AGSGeoModel <AGSJSONSerializable, NSCopying>
 
 
 
#pragma mark -
#pragma mark initializers
 
-(instancetype)init;
 
-(instancetype)initWithSpatialReference:(AGSSpatialReference*)spatialReference;
 
-(instancetype)initWithBasemap:(AGSBasemap*)basemap;
 
-(instancetype)initWithItem:(AGSItem*)item;
 
-(nullable instancetype)initWithURL:(NSURL*)URL;
 
- (instancetype)initWithBasemapStyle:(AGSBasemapStyle)basemapStyle;
 
+(instancetype)map;
 
+(instancetype)mapWithSpatialReference:(AGSSpatialReference*)spatialReference;
 
+(instancetype)mapWithBasemap:(AGSBasemap*)basemap;
 
+(instancetype)mapWithItem:(AGSItem*)item;
 
+(nullable instancetype)mapWithURL:(NSURL*)URL;
 
+ (instancetype)mapWithBasemapStyle:(AGSBasemapStyle)basemapStyle;
 
- (id<AGSCancelable>)namedTraceConfigurationsFromUtilityNetwork:(AGSUtilityNetwork *)utilityNetwork
                                                     completion:(void(^)(NSArray<AGSUtilityNamedTraceConfiguration *> * _Nullable result, NSError * _Nullable error))completion;
 
#pragma mark -
#pragma mark properties
 
@property (nullable, nonatomic, strong, readwrite) AGSColor *backgroundColor;
 
@property (nonatomic, strong, readonly) NSMutableArray<AGSUtilityNetwork *> *utilityNetworks;
 
@property (nonatomic, strong, readwrite) AGSBasemap *basemap;
 
@property (nullable, nonatomic, strong, readonly) AGSOfflineSettings *offlineSettings;
 
@property (nonatomic, assign, readwrite) double minScale;
 
@property (nonatomic, assign, readwrite) double maxScale;
 
@property (nonatomic, assign, readwrite) double referenceScale;
 
@property (nullable, nonatomic, strong, readwrite) AGSViewpoint *initialViewpoint;
 
@property (nullable, nonatomic, strong, readwrite) AGSEnvelope *maxExtent;
 
#pragma mark - Save/SaveAs
 
- (id<AGSCancelable>)saveAs:(NSString *)title
                     portal:(AGSPortal *)portal
                       tags:(NSArray<NSString*> *)tags
                     folder:(nullable AGSPortalFolder *)folder
            itemDescription:(NSString*)itemDescription
                  thumbnail:(nullable AGSImage *)thumbnail
forceSaveToSupportedVersion:(BOOL)forceSaveToSupportedVersion
                 completion:(nullable void(^)(NSError * __nullable error))completion;
 
- (id<AGSCancelable>)saveWithForceSaveToSupportedVersion:(BOOL)forceSaveToSupportedVersion
                                              completion:(nullable void(^)(NSError * __nullable error))completion;
 
@end
 
@interface AGSMap (AGSDeprecated)
 
- (instancetype)initWithBasemapType:(AGSBasemapType)basemapType
                           latitude:(double)latitude
                          longitude:(double)longitude
                      levelOfDetail:(NSInteger)levelOfDetail ;
 
+ (instancetype)mapWithBasemapType:(AGSBasemapType)basemapType
                          latitude:(double)latitude
                         longitude:(double)longitude
                     levelOfDetail:(NSInteger)levelOfDetail ;
 
@end