MGLFillStyleLayer


@interface MGLFillStyleLayer : MGLVectorStyleLayer

An MGLFillStyleLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.

Use a fill style layer to configure the visual appearance of polygon or multipolygon features in vector tiles loaded by an MGLVectorSource object or MGLPolygon, MGLPolygonFeature, MGLMultiPolygon, or MGLMultiPolygonFeature instances in an MGLShapeSource object.

You can access an existing fill style layer using the -[MGLStyle layerWithIdentifier:] method if you know its identifier; otherwise, find it using the MGLStyle.layers property. You can also create a new fill style layer and add it to the style using a method such as -[MGLStyle addLayer:].

Example

let layer = MGLFillStyleLayer(identifier: "parks", source: parks)
layer.sourceLayerIdentifier = "parks"
layer.fillColor = MGLStyleValue(rawValue: .green)
layer.predicate = NSPredicate(format: "type == %@", "national-park")
mapView.style?.addLayer(layer)


                    
                    
                    -initWithIdentifier:source:

Returns a fill style layer initialized with an identifier and source.

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
                                    source:(nonnull MGLSource *)source;

Swift

init(identifier: String, source: MGLSource)

Parameters

`identifier`	A string that uniquely identifies the source in the style to which it is added.
`source`	The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.

Return Value

An initialized foreground style layer.

View Source on GitHub

Accessing the Paint Attributes

fillAntialiased
Whether or not the fill should be antialiased.

The default value of this property is an MGLStyleValue object containing an NSNumber object containing YES. Set this property to nil to reset it to the default value.

This attribute corresponds to the fill-antialias layout property in the Mapbox Style Specification.

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of MGLInterpolationModeInterval
Declaration
Objective-C

@property (getter=isFillAntialiased, assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSNumber *> *fillAntialiased;
Swift

var fillAntialiased: MGLStyleValue
View Source on GitHub
fillColor
The color of the filled part of this layer.

The default value of this property is an MGLStyleValue object containing NSColor.blackColor. Set this property to nil to reset it to the default value.

This property is only applied to the style if fillPattern is set to nil. Otherwise, it is ignored.

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
- MGLSourceStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
  
  MGLInterpolationModeCategorical
  
  MGLInterpolationModeIdentity
- MGLCompositeStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
  
  MGLInterpolationModeCategorical
Declaration
Objective-C

@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSColor *> *fillColor;
Swift

var fillColor: MGLStyleValue
View Source on GitHub
fillColorTransition
The transition affecting any changes to this layer’s fillColor property.

This property corresponds to the fill-color-transition property in the style JSON file format.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) MGLTransition fillColorTransition;
Swift

var fillColorTransition: MGLTransition { get set }
View Source on GitHub
fillOpacity
The opacity of the entire fill layer. In contrast to the fillColor, this value will also affect the 1pt stroke around the fill, if the stroke is used.

The default value of this property is an MGLStyleValue object containing an NSNumber object containing the float 1. Set this property to nil to reset it to the default value.

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
- MGLSourceStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
  
  MGLInterpolationModeCategorical
  
  MGLInterpolationModeIdentity
- MGLCompositeStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
  
  MGLInterpolationModeCategorical
Declaration
Objective-C

@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSNumber *> *fillOpacity;
Swift

var fillOpacity: MGLStyleValue
View Source on GitHub
fillOpacityTransition
The transition affecting any changes to this layer’s fillOpacity property.

This property corresponds to the fill-opacity-transition property in the style JSON file format.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) MGLTransition fillOpacityTransition;
Swift

var fillOpacityTransition: MGLTransition { get set }
View Source on GitHub
fillOutlineColor
The outline color of the fill. Matches the value of fillColor if unspecified.

This property is only applied to the style if fillPattern is set to nil, and fillAntialiased is set to an MGLStyleValue object containing an NSNumber object containing YES. Otherwise, it is ignored.

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
- MGLSourceStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
  
  MGLInterpolationModeCategorical
  
  MGLInterpolationModeIdentity
- MGLCompositeStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
  
  MGLInterpolationModeCategorical
Declaration
Objective-C

@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSColor *> *fillOutlineColor;
Swift

var fillOutlineColor: MGLStyleValue
View Source on GitHub
fillOutlineColorTransition
The transition affecting any changes to this layer’s fillOutlineColor property.

This property corresponds to the fill-outline-color-transition property in the style JSON file format.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) MGLTransition fillOutlineColorTransition;
Swift

var fillOutlineColorTransition: MGLTransition { get set }
View Source on GitHub
fillPattern
Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512).

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of MGLInterpolationModeInterval
Declaration
Objective-C

@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSString *> *fillPattern;
Swift

var fillPattern: MGLStyleValue
View Source on GitHub
fillPatternTransition
The transition affecting any changes to this layer’s fillPattern property.

This property corresponds to the fill-pattern-transition property in the style JSON file format.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) MGLTransition fillPatternTransition;
Swift

var fillPatternTransition: MGLTransition { get set }
View Source on GitHub
fillTranslation
The geometry’s offset.

This property is measured in points.

The default value of this property is an MGLStyleValue object containing an NSValue object containing a CGVector struct set to 0 points rightward and 0 points upward. Set this property to nil to reset it to the default value.

This attribute corresponds to the fill-translate layout property in the Mapbox Style Specification.

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of:
  
  MGLInterpolationModeExponential
  
  MGLInterpolationModeInterval
Declaration
Objective-C

@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslation;
Swift

var fillTranslation: MGLStyleValue
View Source on GitHub
fillTranslationTransition
The transition affecting any changes to this layer’s fillTranslation property.

This property corresponds to the fill-translate-transition property in the style JSON file format.
Declaration
Objective-C

@property (assign, readwrite, nonatomic) MGLTransition fillTranslationTransition;
Swift

var fillTranslationTransition: MGLTransition { get set }
View Source on GitHub
fillTranslationAnchor
Controls the translation reference point.

The default value of this property is an MGLStyleValue object containing an NSValue object containing MGLFillTranslationAnchorMap. Set this property to nil to reset it to the default value.

This property is only applied to the style if fillTranslation is non-nil. Otherwise, it is ignored.

This attribute corresponds to the fill-translate-anchor layout property in the Mapbox Style Specification.

You can set this property to an instance of:
- MGLConstantStyleValue
- MGLCameraStyleFunction with an interpolation mode of MGLInterpolationModeInterval
Declaration
Objective-C

@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSValue *> *fillTranslationAnchor;
Swift

var fillTranslationAnchor: MGLStyleValue
View Source on GitHub