MGLLineStyleLayer

@interface MGLLineStyleLayer : MGLVectorStyleLayer

A line layer which allows customization of styling properties at runtime. You may instantiate a new line layer to add to a map style or you may query an MGLMapView for its style and obtain existing layers using the -[MGLStyle layerWithIdentifier:] method.

Accessing the Layout Attributes

  • The display of line endings.

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

    Declaration

    Objective-C

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

    Swift

    var lineCap: MGLStyleValue! { get set }
    show on github

  • The display of lines when joining.

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

    Declaration

    Objective-C

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

    Swift

    var lineJoin: MGLStyleValue! { get set }
    show on github

  • Used to automatically convert miter joins to bevel joins for sharp angles.

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

    This property is only applied to the style if lineJoin is set to an MGLStyleValue object containing an NSValue object containing MGLLineJoinMiter. Otherwise, it is ignored.

    Declaration

    Objective-C

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

    Swift

    var lineMiterLimit: MGLStyleValue! { get set }
    show on github

  • Used to automatically convert round joins to miter joins for shallow angles.

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

    This property is only applied to the style if lineJoin is set to an MGLStyleValue object containing an NSValue object containing MGLLineJoinRound. Otherwise, it is ignored.

    Declaration

    Objective-C

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

    Swift

    var lineRoundLimit: MGLStyleValue! { get set }
    show on github

Accessing the Paint Attributes

  • The opacity at which the line 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 *> *lineOpacity;

    Swift

    var lineOpacity: MGLStyleValue! { get set }
    show on github

  • The color with which the line will be drawn.

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

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

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, null_resettable)
    MGLStyleValue<UIColor *> *lineColor;

    Swift

    var lineColor: MGLStyleValue! { get set }
    show on github

  • The geometry’s offset. Values are [x, y] where negatives indicate left and up, respectively.

    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 from the left and 0 points from the top. Set this property to nil to reset it to the default value.

    Declaration

    Objective-C

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

    Swift

    var lineTranslate: MGLStyleValue! { get set }
    show on github

  • Controls the translation reference point.

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

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

    Declaration

    Objective-C

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

    Swift

    var lineTranslateAnchor: MGLStyleValue! { get set }
    show on github

  • Stroke thickness.

    This property is measured in points.

    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 *> *lineWidth;

    Swift

    var lineWidth: MGLStyleValue! { get set }
    show on github

  • Draws a line casing outside of a line’s actual path. Value indicates the width of the inner gap.

    This property is measured in points.

    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 *> *lineGapWidth;

    Swift

    var lineGapWidth: MGLStyleValue! { get set }
    show on github

  • The line’s offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.

    This property is measured in points.

    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 *> *lineOffset;

    Swift

    var lineOffset: MGLStyleValue! { get set }
    show on github

  • Blur applied to the line, in points.

    This property is measured in points.

    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 *> *lineBlur;

    Swift

    var lineBlur: MGLStyleValue! { get set }
    show on github

  • Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to points, multiply the length by the current line width.

    This property is measured in line widths.

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

    Declaration

    Objective-C

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

    Swift

    var lineDasharray: MGLStyleValue! { get set }
    show on github

  • Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, …, 512).

    Declaration

    Objective-C

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

    Swift

    var linePattern: MGLStyleValue! { get set }
    show on github