AGSMap.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 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 <ArcGIS/AGSLoadableBase.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSImage.h>
#import <ArcGIS/AGSColor.h>
#import <ArcGIS/AGSBasemap.h>

@class AGSLayer;
@class AGSPortalItem;
@class AGSEnvelope;
@class AGSPortal;
@class AGSPortalFolder;
@class AGSViewpoint;
@class AGSItem;
@class AGSBookmark;
@class AGSTransportationNetworkDataset;
@class AGSFeatureTable;
@class AGSLoadSettings;
@class AGSOfflineSettings;
@class AGSSpatialReference;

@protocol AGSCancelable;
 //Required for Globals API doc

@interface AGSMap : AGSLoadableBase <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)initWithBasemapType:(AGSBasemapType)basemapType latitude:(double)latitude longitude:(double)longitude levelOfDetail:(NSInteger)levelOfDetail;

+(instancetype)map;

+(instancetype)mapWithSpatialReference:(AGSSpatialReference*)spatialReference;

+(instancetype)mapWithBasemap:(AGSBasemap*)basemap;

+(instancetype)mapWithItem:(AGSItem*)item;

+(instancetype)mapWithBasemapType:(AGSBasemapType)basemapType latitude:(double)latitude longitude:(double)longitude levelOfDetail:(NSInteger)levelOfDetail;

+(nullable instancetype)mapWithURL:(NSURL*)URL;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, strong, readwrite) AGSColor *backgroundColor;

@property (nullable, nonatomic, strong, readonly) AGSItem *item;

@property (nonatomic, copy, readonly) NSArray<AGSTransportationNetworkDataset*> *transportationNetworks;

@property (nonatomic, copy, readonly) NSString *version;

@property (nonatomic, strong, readwrite) AGSBasemap *basemap;

@property (nonatomic, strong, readonly) NSMutableArray<AGSLayer*> *operationalLayers;

@property (nullable, nonatomic, strong, readonly) AGSOfflineSettings *offlineSettings;

@property (nonatomic, strong, readonly) NSMutableArray<AGSFeatureTable*> *tables;

@property (nonatomic, assign, readwrite) double minScale;

@property (nonatomic, assign, readwrite) double maxScale;

@property (nonatomic, assign, readwrite) double referenceScale;

@property (nullable, nonatomic, strong, readonly) AGSSpatialReference *spatialReference;

@property (nonatomic, strong, readonly) NSMutableArray<AGSBookmark*> *bookmarks;

@property (nullable, nonatomic, strong, readwrite) AGSViewpoint *initialViewpoint;

@property (nonatomic, strong, readwrite) AGSLoadSettings *loadSettings;

#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