MGLTileSource

@interface MGLTileSource : MGLSource

MGLTileSource is a map content source that supplies map 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 tile source is added to an MGLStyle object along with one or more MGLRasterStyleLayer or MGLVectorStyleLayer objects. Use a style layer to control the appearance of content supplied by the tile source.

Do not create instances of this class directly, and do not create your own subclasses of this class. Instead, create instances of MGLRasterSource and MGLVectorSource.

Initializing a Source

  • Returns a 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 tile sets hosted by Mapbox, a Mapbox URL indicating a map identifier (mapbox://<mapid>). 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;

    Swift

    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 tile source.

    show on github

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

    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.
    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.

    show on github

Accessing Attribution Strings

  • An array of MGLAttributionInfo objects that define the attribution statements to be displayed when the map is shown to the user.

    By default, this array is empty. If the source is initialized with a configuration URL, this array is also empty until the configuration JSON file is loaded.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic)
    NSArray<MGLAttributionInfo *> *_Nonnull attributionInfos;

    Swift

    var attributionInfos: [MGLAttributionInfo] { get }
    show on github