RMMapboxSource Class Reference
| Inherits from | RMAbstractWebMapSource : RMAbstractMercatorTileSource : NSObject |
| Declared in | RMMapboxSource.h |
Overview
An RMMapboxSource is used to display map tiles from a network-based map hosted on Mapbox or the open source TileStream software. Maps are referenced by their Mapbox map ID or by a file or URL containing TileJSON.
Tasks
Creating Tile Sources
-
– initWithMapID: -
– initWithReferenceURL: -
– initWithTileJSON: -
– initWithMapID:enablingDataOnMapView: -
– initWithTileJSON:enablingDataOnMapView: -
– initWithReferenceURL:enablingDataOnMapView:
Querying Tile Source Information
-
– legend -
– centerCoordinate -
– centerZoom -
– coversFullWorld -
tileJSONproperty -
tileJSONURLproperty -
infoDictionaryproperty
Configuring Map Options
-
imageQualityproperty
Properties
imageQuality
Image quality that is retrieved from the network. Useful for lower-bandwidth environments. The default is to provide full-quality imagery.
@property (nonatomic, assign) RMMapboxSourceQuality imageQualityDiscussion
Image quality that is retrieved from the network. Useful for lower-bandwidth environments. The default is to provide full-quality imagery.
Note that you may want to clear the tile cache after changing this value in order to provide a consistent experience.
Declared In
RMMapboxSource.hinfoDictionary
The TileJSON data in dictionary format. Useful for retrieving info about the layer without having to parse TileJSON.
@property (nonatomic, readonly, strong) NSDictionary *infoDictionaryDiscussion
The TileJSON data in dictionary format. Useful for retrieving info about the layer without having to parse TileJSON.
Declared In
RMMapboxSource.htileJSON
The TileJSON for the map layer. Useful for saving locally to use in instantiating a tile source while offline.
@property (nonatomic, readonly, strong) NSString *tileJSONDiscussion
The TileJSON for the map layer. Useful for saving locally to use in instantiating a tile source while offline.
Declared In
RMMapboxSource.htileJSONURL
The TileJSON URL for the map layer. Useful for retrieving TileJSON to save locally to use in instantiating a tile source while offline.
@property (nonatomic, readonly, strong) NSURL *tileJSONURLDiscussion
The TileJSON URL for the map layer. Useful for retrieving TileJSON to save locally to use in instantiating a tile source while offline.
Declared In
RMMapboxSource.hInstance Methods
centerCoordinate
A suggested starting center coordinate for the map layer.
- (CLLocationCoordinate2D)centerCoordinateDiscussion
A suggested starting center coordinate for the map layer.
Declared In
RMMapboxSource.hcenterZoom
A suggested starting center zoom level for the map layer.
- (float)centerZoomDiscussion
A suggested starting center zoom level for the map layer.
Declared In
RMMapboxSource.hcoversFullWorld
Returns YES if the tile source provides full-world coverage; otherwise, returns NO.
- (BOOL)coversFullWorldDiscussion
Returns YES if the tile source provides full-world coverage; otherwise, returns NO.
Declared In
RMMapboxSource.hinitWithMapID:
Initialize a tile source using the Mapbox map ID.
- (id)initWithMapID:(NSString *)mapIDParameters
- mapID
The Mapbox map ID string, typically in the format
<username>.map-<random characters>.
Return Value
An initialized Mapbox tile source.
Discussion
Initialize a tile source using the Mapbox map ID.
This method requires a network connection in order to download the TileJSON used to define the tile source.
Declared In
RMMapboxSource.hinitWithMapID:enablingDataOnMapView:
For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add point annotations from simplestyle data.
- (id)initWithMapID:(NSString *)mapID enablingDataOnMapView:(RMMapView *)mapViewParameters
- mapID
The Mapbox map ID string, typically in the format
<username>.map-<random characters>.
- mapView
A map view on which to display the annotations.
Return Value
An initialized Mapbox tile source.
Discussion
For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add point annotations from simplestyle data.
This method requires a network connection in order to download the TileJSON used to define the tile source.
Declared In
RMMapboxSource.hinitWithReferenceURL:
Initialize a tile source with either a remote or local TileJSON structure.
- (id)initWithReferenceURL:(NSURL *)referenceURLParameters
- referenceURL
A remote or file path URL pointing to a TileJSON structure.
Return Value
An initialized Mapbox tile source.
Discussion
Initialize a tile source with either a remote or local TileJSON structure.
Passing a remote URL requires a network connection. If offline functionality is desired, you should cache the TileJSON locally at a prior date, then pass a file path URL to this method.
See Also
Declared In
RMMapboxSource.hinitWithReferenceURL:enablingDataOnMapView:
For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add point annotations from simplestyle data.
- (id)initWithReferenceURL:(NSURL *)referenceURL enablingDataOnMapView:(RMMapView *)mapViewParameters
- referenceURL
A remote or file path URL pointing to a TileJSON structure.
- mapView
A map view on which to display the annotations.
Return Value
An initialized Mapbox tile source.
Discussion
For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add point annotations from simplestyle data.
Passing a remote URL requires a network connection. If offline functionality is desired, you should cache the TileJSON locally at a prior date, then pass a file path URL to this method.
See Also
Declared In
RMMapboxSource.hinitWithTileJSON:
Initialize a tile source with TileJSON.
- (id)initWithTileJSON:(NSString *)tileJSONParameters
- tileJSON
A string containing TileJSON.
Return Value
An initialized Mapbox tile source.
Discussion
Initialize a tile source with TileJSON.
Declared In
RMMapboxSource.hinitWithTileJSON:enablingDataOnMapView:
For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add point annotations from simplestyle data.
- (id)initWithTileJSON:(NSString *)tileJSON enablingDataOnMapView:(RMMapView *)mapViewParameters
- tileJSON
A string containing TileJSON.
- mapView
A map view on which to display the annotations.
Return Value
An initialized Mapbox tile source.
Discussion
For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add point annotations from simplestyle data.
Declared In
RMMapboxSource.h