iOS SDK

API Reference

On This Page

MGLRasterTileSource

@interface MGLRasterTileSource : MGLTileSource

MGLRasterTileSource is a map content source that supplies raster image tiles to be shown on the map. The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification. A raster tile source is added to an MGLStyle object along with one or more MGLRasterStyleLayer objects. Use a raster style layer to control the appearance of content supplied by the raster tile source.

Each raster source defined by the style JSON file is represented at runtime by an MGLRasterTileSource object that you can use to initialize new style layers. You can also add and remove sources dynamically using methods such as -[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

Example

let source = MGLRasterTileSource(identifier: "clouds", tileURLTemplates: ["https://example.com/raster-tiles/{z}/{x}/{y}.png"], options: [
.minimumZoomLevel: 9,
.maximumZoomLevel: 16,
.tileSize: 512,
.attributionInfos: [
    MGLAttributionInfo(title: NSAttributedString(string: "© Mapbox"), url: URL(string: "https://mapbox.com"))
]
])
mapView.style?.addSource(source)

Initializing a Source

-initWithIdentifier:configurationURL:

Returns a raster tile source initialized with an identifier and configuration URL.

After initializing and configuring the source, add it to a map view’s style using the -[MGLStyle addSource:] method.

The URL may be a full HTTP or HTTPS URL or, for tilesets hosted by Mapbox, a Mapbox URL indicating a tileset ID (mapbox://<tilesetid>). The URL should point to a JSON file that conforms to the TileJSON specification.

If a Mapbox URL is specified, this source uses a tile size of 256. For all other tilesets, the default value is 512. (See the MGLTileSourceOptionTileSize documentation for more information about tile sizes.) If you need to use a tile size other than the default, use the -initWithIdentifier:configurationURL:tileSize: method.

Declaration

Objective-C

- (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
                      configurationURL:(nonnull NSURL *)configurationURL;

Swift

convenience init(identifier: String, configurationURL: URL)

Parameters

identifier

A string that uniquely identifies the source in the style to which it is added.

configurationURL

A URL to a TileJSON configuration file describing the source’s contents and other metadata.

Return Value

An initialized raster tile source.

-initWithIdentifier:configurationURL:tileSize:

Returns a raster tile source initialized with an identifier, configuration URL, and tile size.

After initializing and configuring the source, add it to a map view’s style using the -[MGLStyle addSource:] method.

The URL may be a full HTTP or HTTPS URL or, for tilesets hosted by Mapbox, a Mapbox URL indicating a tileset ID (mapbox://<tilesetid>). The URL should point to a JSON file that conforms to the TileJSON specification.

Declaration

Objective-C

- (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
                      configurationURL:(nonnull NSURL *)configurationURL
                              tileSize:(CGFloat)tileSize;

Swift

init(identifier: String, configurationURL: URL, tileSize: CGFloat)

Parameters

identifier

A string that uniquely identifies the source in the style to which it is added.

configurationURL

A URL to a TileJSON configuration file describing the source’s contents and other metadata.

tileSize

The width and height (measured in points) of each tiled image in the raster tile source. See the MGLTileSourceOptionTileSize documentation for details.

Return Value

An initialized raster tile source.

-initWithIdentifier:tileURLTemplates:options:

Returns a raster tile source initialized an identifier, tile URL templates, and options.

Tile URL templates are strings that specify the URLs of the raster tile images to load. See the “Tile URL Templates” guide for information about the format of a tile URL template.

After initializing and configuring the source, add it to a map view’s style using the -[MGLStyle addSource:] method.

Declaration

Objective-C

- (nonnull instancetype)
initWithIdentifier:(nonnull NSString *)identifier
  tileURLTemplates:(nonnull NSArray<NSString *> *)tileURLTemplates
           options:
               (nullable NSDictionary<MGLTileSourceOption, id> *)options;

Swift

init(identifier: String, tileURLTemplates: [String], options: [MGLTileSourceOption : Any]? = nil)

Parameters

identifier

A string that uniquely identifies the source in the style to which it is added.

tileURLTemplates

An array of tile URL template strings. Only the first string is used; any additional strings are ignored.

options

A dictionary containing configuration options. See MGLTileSourceOption for available keys and values. Pass in nil to use the default values.

Return Value

An initialized tile source.