AGSWebMap Class Reference
Description
Instances of this class represent a web map. A web map is basically a simple configuration file that describes the contents to be displayed in a map. You can use create and share web maps interactively on www.ArcGIS.com. At this time, only reading layer information in a web map is supported. All other information in the web map is ignored.
Note, instantiating a AGSWebMap object is a synchronous operation. You shouldn't perform it on the main application thread as it may prevent your application from responding to user input while the web map information is being retrieved from the server.
When a web map is opened into a map view, the web map's delegate is kept informed of the progress. For exmaple, as each layer in the web map is loaded successfully, the delegate is informed. If any layers fail to load, the delegate is given an opportunity to skip to the next layer, or re-try loading the current layer with proper credentials if the layer was using a secured service. If the web map contains a Bing Maps layer, the delegate is asked to provide a valid Bing Maps app ID to use with that layer.
- Since:
- 1.8
Public Member Functions | |
| (void) | - cancelOpen |
| (void) | - continueOpenAndSkipCurrentLayer |
| (void) | - continueOpenWithCredential: |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithItemId:credential:error: |
| (id) | - initWithItemId:sharingEndPoint:credential:error: |
| (id) | - initWithJSON: |
| (id) | - initWithURL:credential:error: |
| (void) | - openIntoMapView: |
| (void) | - openIntoMapView:withAlternateBaseMap: |
Static Public Member Functions | |
| (AGSWebMap *) | + webMapWithItemId:credential:error: |
| (AGSWebMap *) | + webMapWithItemId:sharingEndPoint:credential:error: |
| (AGSWebMap *) | + webMapWithURL:credential:error: |
Properties | |
| BOOL | containsBingLayer |
| AGSCredential * | credential |
| NSObject< AGSWebMapDelegate > * | delegate |
| NSDictionary * | json |
| NSURL * | URL |
| AGSWebMapInfo * | webMapInfo |
| BOOL | zoomToDefaultExtentOnOpen |
Member Function Documentation
| - (void) cancelOpen |
Cancels opening the webmap.
- Since:
- 1.8
| - (void) continueOpenAndSkipCurrentLayer |
Continues opening the webmap and skips the current layer that failed.
- Since:
- 1.8
| - (void) continueOpenWithCredential: | (AGSCredential *) | credential |
Continues opening the webmap with a credential.
- Since:
- 1.8
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithItemId: | (NSString *) | itemId | ||
| credential: | (AGSCredential *) | cred | ||
| error: | (NSError **) | error | ||
Initializes a webmap.
- Parameters:
-
itemId The item id of the webmap on ArcGIS.com cred The credential to access the webmap. error Will be populated with any error that occurs.
- Since:
- 1.8
| - (id) initWithItemId: | (NSString *) | itemId | ||
| sharingEndPoint: | (NSURL *) | sharingEndPoint | ||
| credential: | (AGSCredential *) | cred | ||
| error: | (NSError **) | error | ||
Initializes a webmap.
- Parameters:
-
itemId The item id of the webmap. sharingEndPoint The sharing endpoint of where the webmap is stored. Can be nil, in which case ArcGIS.com is used. cred The credential to access the webmap. error Will be populated with any error that occurs.
- Since:
- 1.8
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
| - (id) initWithURL: | (NSURL *) | url | ||
| credential: | (AGSCredential *) | cred | ||
| error: | (NSError **) | error | ||
Initializes a webmap.
- Parameters:
-
url The url to the webmap. cred The credential to access the webmap. error Will be populated with any error that occurs.
- Since:
- 1.8
| - (void) openIntoMapView: | (AGSMapView *) | mapView |
Starts opening a webmap into an AGSMapView.
- Parameters:
-
mapView The mapView to open the webmap into.
- Since:
- 1.8
| - (void) openIntoMapView: | (AGSMapView *) | mapView | ||
| withAlternateBaseMap: | (AGSWebMap *) | baseMap | ||
Starts opening a webmap into an AGSMapView.
- Parameters:
-
mapView The mapView to open the webmap into. baseMap A webmap that contains an alternate basemap to use. Will ignore the operational layers of this webmap. Can pass nil for this parameter, in which case it will use the default basemap.
- Since:
- 1.8
| + (AGSWebMap*) webMapWithItemId: | (NSString *) | itemId | ||
| credential: | (AGSCredential *) | cred | ||
| error: | (NSError **) | error | ||
Returns an autoreleased webmap.
- Parameters:
-
itemId The item id of the webmap on ArcGIS.com cred The credential to access the webmap. error Will be populated with any error that occurs.
- Since:
- 1.8
| + (AGSWebMap*) webMapWithItemId: | (NSString *) | itemId | ||
| sharingEndPoint: | (NSURL *) | sharingEndPoint | ||
| credential: | (AGSCredential *) | cred | ||
| error: | (NSError **) | error | ||
Returns an autoreleased webmap.
- Parameters:
-
itemId The item id of the webmap. sharingEndPoint The sharing endpoint of where the webmap is stored. Can be nil, in which case ArcGIS.com is used. cred The credential to access the webmap. error Will be populated with any error that occurs.
- Since:
- 1.8
| + (AGSWebMap*) webMapWithURL: | (NSURL *) | url | ||
| credential: | (AGSCredential *) | cred | ||
| error: | (NSError **) | error | ||
Returns an autoreleased webmap.
- Parameters:
-
url The url to the webmap. cred The credential to access the webmap. error Will be populated with any error that occurs.
- Since:
- 1.8
Property Documentation
- (BOOL) containsBingLayer [read, assign] |
Whether or not the webmap contains a bing layer. This property isn't guaranteed populated until the webmap is opened into a mapview. The reason is that it's value depends on the basemap used to open into a mapview.
- Since:
- 1.8
- (AGSCredential*) credential [read, copy] |
Credential used to access a secured resource
- Since:
- 1.8
- (NSObject<AGSWebMapDelegate>*) delegate [read, write, assign] |
The delegate for the webmap.
- Since:
- 1.8
- (NSDictionary*) json [read, retain] |
The json returned from the webmap.
- Since:
- 1.8
- (NSURL*) URL [read, copy] |
The URL of the webmap end point.
- Since:
- 1.8
- (AGSWebMapInfo*) webMapInfo [read, write, retain] |
Provides metadata about the webmap.
- Since:
- 1.8
- (BOOL) zoomToDefaultExtentOnOpen [read, write, assign] |
Determines whether the webmap zooms to the default webmap extent when it is opened into a mapview.
- Since:
- 1.8