MGLCircleStyleLayer

 
@interface MGLCircleStyleLayer : MGLVectorStyleLayer

An MGLCircleStyleLayer is a style layer that renders one or more filled circles on the map.

Use a circle style layer to configure the visual appearance of point or point collection features in vector tiles loaded by an MGLVectorSource object or MGLPointAnnotation, MGLPointFeature, MGLPointCollection, or MGLPointCollectionFeature instances in an MGLShapeSource object.

A circle style layer renders circles whose radii are measured in screen units. To display circles on the map whose radii correspond to real-world distances, use many-sided regular polygons and configure their appearance using an MGLFillStyleLayer object.

You can access an existing circle 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 circle style layer and add it to the style using a method such as -[MGLStyle addLayer:].

Example

let layer = MGLCircleStyleLayer(identifier: circles, source: population)
layer.sourceLayerIdentifier = population
layer.circleColor = MGLStyleValue(rawValue: .green)
layer.circleRadius = MGLStyleValue(interpolationBase: 1.75, stops: [
    12: MGLStyleValue(rawValue: 2),
    22: MGLStyleValue(rawValue: 180)
])
layer.circleOpacity = MGLStyleValue(rawValue: 0.7)
layer.predicate = NSPredicate(format: %K == %@, marital-status, married)
mapView.style?.addLayer(layer)

Accessing the Paint Attributes

  • Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

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

    Declaration

    Objective-C

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

    Swift

    var circleBlur: MGLStyleValue
    View Source on GitHub

  • The fill color of the circle.

    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.

    Declaration

    Objective-C

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

    Swift

    var circleColor: MGLStyleValue
    View Source on GitHub

  • The opacity at which the circle will be drawn.

    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.

    Declaration

    Objective-C

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

    Swift

    var circleOpacity: MGLStyleValue
    View Source on GitHub

  • Circle radius.

    This property is measured in points.

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

    Declaration

    Objective-C

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

    Swift

    var circleRadius: MGLStyleValue
    View Source on GitHub

  • Controls the scaling behavior of the circle when the map is pitched.

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

    This attribute corresponds to the circle-pitch-scale layout property in the Mapbox Style Specification.

    Declaration

    Objective-C

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

    Swift

    var circleScaleAlignment: MGLStyleValue
    View Source on GitHub

  • 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 circle-translate layout property in the Mapbox Style Specification.

    Declaration

    Objective-C

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

    Swift

    var circleTranslation: MGLStyleValue
    View Source on GitHub

  • Controls the translation reference point.

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

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

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

    Declaration

    Objective-C

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

    Swift

    var circleTranslationAnchor: MGLStyleValue
    View Source on GitHub