MGLStyleLayer

 
@interface MGLStyleLayer : NSObject

MGLStyleLayer is an abstract base class for style layers. A style layer manages the layout and appearance of content at a specific z-index in a style. An MGLStyle object consists of one or more MGLStyleLayer objects.

Each style layer defined by the style JSON file is represented at runtime by an MGLStyleLayer object, which you can use to refine the map’s appearance. You can also add and remove style layers dynamically.

Do not create instances of this class directly, and do not create your own subclasses of this class. Instead, create instances of MGLBackgroundStyleLayer and the concrete subclasses of MGLForegroundStyleLayer.

Initializing a Style Layer

  • Returns a style layer object initialized with the given identifier.

    The default implementation of this initializer in MGLStyleLayer creates an invalid style layer. Call this initializer on MGLBackgroundStyleLayer or one of the concrete subclasses of MGLForegroundStyleLayer to create a valid style layer.

    After initializing and configuring the style layer, add it to a map view’s style using the -[MGLStyle addLayer:] or -[MGLStyle insertLayer:belowLayer:] method.

    Declaration

    Objective-C

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

    Swift

    init(identifier: String)

    Parameters

    identifier

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

    Return Value

    An initialized style layer.

    View Source on GitHub

Identifying a Style Layer

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

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic) NSString *_Nonnull identifier;

    Swift

    var identifier: String { get }
    View Source on GitHub

Configuring a Style Layer’s Visibility

  • Whether this layer is displayed. A value of NO hides the layer.

    Declaration

    Objective-C

    @property (getter=isVisible, assign, readwrite, nonatomic) BOOL visible;

    Swift

    var isVisible: Bool { get set }
    View Source on GitHub

  • The maximum zoom level at which the layer gets parsed and appears.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float maximumZoomLevel;

    Swift

    var maximumZoomLevel: Float { get set }
    View Source on GitHub

  • The minimum zoom level at which the layer gets parsed and appears.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float minimumZoomLevel;

    Swift

    var minimumZoomLevel: Float { get set }
    View Source on GitHub