AGSBasemap.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
 */
 //Required for Globals API doc

#import <ArcGIS/AGSLoadableBase.h>
#import <ArcGIS/AGSJSONSerializable.h>



typedef NS_ENUM(NSInteger, AGSBasemapType) {
    AGSBasemapTypeImagery = 0,                  
    AGSBasemapTypeImageryWithLabels = 1,        
    AGSBasemapTypeStreets = 2,                  
    AGSBasemapTypeTopographic = 3,              
    AGSBasemapTypeTerrainWithLabels = 4,        
    AGSBasemapTypeLightGrayCanvas = 5,          
    AGSBasemapTypeNationalGeographic = 6,       
    AGSBasemapTypeOceans = 7,                   
    AGSBasemapTypeOpenStreetMap = 8,            
    AGSBasemapTypeImageryWithLabelsVector = 9,  
    AGSBasemapTypeStreetsVector = 10,           
    AGSBasemapTypeTopographicVector = 11,       
    AGSBasemapTypeTerrainWithLabelsVector = 12, 
    AGSBasemapTypeLightGrayCanvasVector = 13,   
    AGSBasemapTypeNavigationVector = 14,        
    AGSBasemapTypeStreetsNightVector = 15,      
    AGSBasemapTypeStreetsWithReliefVector = 16, 
    AGSBasemapTypeDarkGrayCanvasVector = 17     
};

@class AGSItem;
@class AGSLayer;

@interface AGSBasemap : AGSLoadableBase <AGSJSONSerializable, NSCopying>

#pragma mark -
#pragma mark initializers

-(instancetype)init;

-(instancetype)initWithItem:(AGSItem*)item;

-(instancetype)initWithBaseLayer:(AGSLayer*)layer;

-(instancetype)initWithBaseLayers:(NSArray<AGSLayer*>*)baseLayers referenceLayers:(nullable NSArray<AGSLayer*>*)referenceLayers;

-(nullable instancetype)initWithURL:(NSURL*)URL;
    
+(instancetype)basemap;

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

+(instancetype)basemapWithBaseLayer:(AGSLayer*)layer;

+(instancetype)basemapWithBaseLayers:(NSArray<AGSLayer*>*)baseLayers referenceLayers:(nullable NSArray<AGSLayer*>*)referenceLayers;

+(nullable instancetype)basemapWithURL:(NSURL*)URL;
    
+(instancetype)streetsBasemap;

+(instancetype)topographicBasemap;

+(instancetype)imageryBasemap;

+(instancetype)darkGrayCanvasVectorBasemap;

+(instancetype)imageryWithLabelsVectorBasemap;

+(instancetype)lightGrayCanvasVectorBasemap;

+(instancetype)navigationVectorBasemap;

+(instancetype)openStreetMapBasemap;

+(instancetype)streetsNightVectorBasemap;

+(instancetype)streetsVectorBasemap;

+(instancetype)streetsWithReliefVectorBasemap;

+(instancetype)terrainWithLabelsVectorBasemap;

+(instancetype)topographicVectorBasemap;

+(instancetype)lightGrayCanvasBasemap;

+(instancetype)oceansBasemap;

+(instancetype)nationalGeographicBasemap;

+(instancetype)imageryWithLabelsBasemap;

+(instancetype)terrainWithLabelsBasemap;

#pragma mark -
#pragma mark properties

@property (nonatomic, copy, readwrite) NSString *name;

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

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

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

#pragma mark -
#pragma mark methods

@end