MGLStyle

@interface MGLStyle : NSObject

A collection of convenience methods for creating style URLs of default styles provided by Mapbox. Learn more about Mapbox default styles.

  • Returns the URL to version 8 of the Mapbox Streets style.

    Streets is a general-purpose style with detailed road and transit networks.

    MGLMapView and MGLTilePyramidOfflineRegion use Mapbox Streets when no style is specified explicitly.

    Declaration

    Objective-C

    + (nonnull NSURL *)streetsStyleURL;

    Swift

    class func streetsStyleURL() -> NSURL
  • Returns the URL to the given version of the Mapbox Streets style.

    Streets is a general-purpose style with detailed road and transit networks.

    MGLMapView and MGLTilePyramidOfflineRegion use Mapbox Streets when no style is specified explicitly.

    Declaration

    Objective-C

    + (nonnull NSURL *)streetsStyleURLWithVersion:(NSInteger)version;

    Swift

    class func streetsStyleURLWithVersion(version: Int) -> NSURL

    Parameters

    version

    The style’s latest released version. As of publication, the current version is 9.

  • Returns the URL to version 8 of the Mapbox Emerald style.

    Emerald is a tactile style with subtle textures and dramatic hillshading.

    Declaration

    Objective-C

    + (nonnull NSURL *)emeraldStyleURL;

    Swift

    class func emeraldStyleURL() -> NSURL
  • Returns the URL to the given version of the Mapbox Outdoors style.

    Outdoors is a general-purpose style tailored to outdoor activities.

    Declaration

    Objective-C

    + (nonnull NSURL *)outdoorsStyleURLWithVersion:(NSInteger)version;

    Swift

    class func outdoorsStyleURLWithVersion(version: Int) -> NSURL

    Parameters

    version

    The style’s latest released version. As of publication, the current version is 9.

  • Returns the URL to version 8 of the Mapbox Light style.

    Light is a subtle, light-colored backdrop for data visualizations.

    Declaration

    Objective-C

    + (nonnull NSURL *)lightStyleURL;

    Swift

    class func lightStyleURL() -> NSURL
  • Returns the URL to the given version of the Mapbox Light style.

    Light is a subtle, light-colored backdrop for data visualizations.

    Declaration

    Objective-C

    + (nonnull NSURL *)lightStyleURLWithVersion:(NSInteger)version;

    Swift

    class func lightStyleURLWithVersion(version: Int) -> NSURL

    Parameters

    version

    The style’s latest released version. As of publication, the current version is 9.

  • Returns the URL to version 8 of the Mapbox Dark style.

    Dark is a subtle, dark-colored backdrop for data visualizations.

    Declaration

    Objective-C

    + (nonnull NSURL *)darkStyleURL;

    Swift

    class func darkStyleURL() -> NSURL
  • Returns the URL to the given version of the Mapbox Dark style.

    Dark is a subtle, dark-colored backdrop for data visualizations.

    Declaration

    Objective-C

    + (nonnull NSURL *)darkStyleURLWithVersion:(NSInteger)version;

    Swift

    class func darkStyleURLWithVersion(version: Int) -> NSURL

    Parameters

    version

    The style’s latest released version. As of publication, the current version is 9.

  • Returns the URL to version 8 of the Mapbox Satellite style.

    Satellite is high-resolution satellite and aerial imagery.

    Declaration

    Objective-C

    + (nonnull NSURL *)satelliteStyleURL;

    Swift

    class func satelliteStyleURL() -> NSURL
  • Returns the URL to the given version of the Mapbox Satellite style.

    Satellite is high-resolution satellite and aerial imagery.

    Declaration

    Objective-C

    + (nonnull NSURL *)satelliteStyleURLWithVersion:(NSInteger)version;

    Swift

    class func satelliteStyleURLWithVersion(version: Int) -> NSURL

    Parameters

    version

    The style’s latest released version. As of publication, the current version is 9.

  • Returns the URL to version 8 of the Mapbox Satellite Streets style.

    Satellite Streets combines the high-resolution satellite and aerial imagery of Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox Streets.

    Declaration

    Objective-C

    + (nonnull NSURL *)hybridStyleURL;

    Swift

    class func hybridStyleURL() -> NSURL
  • Returns the URL to the given version of the Mapbox Satellite Streets style.

    Satellite Streets combines the high-resolution satellite and aerial imagery of Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox Streets.

    Declaration

    Objective-C

    + (nonnull NSURL *)satelliteStreetsStyleURLWithVersion:(NSInteger)version;

    Swift

    class func satelliteStreetsStyleURLWithVersion(version: Int) -> NSURL

    Parameters

    version

    The style’s latest released version. As of publication, the current version is 9.

  • Returns a layer that conforms to MGLStyleLayer if any layer with the given identifier was found.

    Declaration

    Objective-C

    - (nullable id<MGLStyleLayer>)layerWithIdentifier:
        (nonnull NSString *)identifier;

    Swift

    func layerWithIdentifier(identifier: String) -> MGLStyleLayer?

    Return Value

    layer A layer instance of the corresponding type.

  • Adds a new layer at the top of the hierarchy.

    Declaration

    Objective-C

    - (void)addLayer:(nonnull id<MGLStyleLayer>)styleLayer;

    Swift

    func addLayer(styleLayer: MGLStyleLayer)

    Parameters

    styleLayer

    The layer object to add to the map view. This object must conform to the MGLStyleLayer protocol.

  • Inserts a new layer below another layer.

    Declaration

    Objective-C

    - (void)insertLayer:(nonnull id<MGLStyleLayer>)styleLayer
             belowLayer:(nonnull id<MGLStyleLayer>)belowLayer;

    Swift

    func insertLayer(styleLayer: MGLStyleLayer, belowLayer: MGLStyleLayer)

    Parameters

    styleLayer

    Layer to be inserted.

    belowLayer

    A layer that’s already on the map view.

  • Removes a layer from the map view.

    Declaration

    Objective-C

    - (void)removeLayer:(nonnull id<MGLStyleLayer>)styleLayer;

    Swift

    func removeLayer(styleLayer: MGLStyleLayer)

    Parameters

    styleLayer

    The layer object to remove from the map view. This object must conform to the MGLStyleLayer protocol.

  • Adds a new source to the map view.

    Declaration

    Objective-C

    - (void)addSource:(nonnull MGLSource *)source;

    Swift

    func addSource(source: MGLSource)

    Parameters

    source

    The source to add to the map view.

  • Removes a source from the map view.

    Declaration

    Objective-C

    - (void)removeSource:(nonnull MGLSource *)source;

    Swift

    func removeSource(source: MGLSource)

    Parameters

    source

    The source to remove.