// This file is generated. // Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" #import "MGLVectorStyleLayer.h" NS_ASSUME_NONNULL_BEGIN /** The display of line endings. Values of this type are used in the `MGLLineStyleLayer.lineCap` property. */ typedef NS_ENUM(NSUInteger, MGLLineCap) { /** A cap with a squared-off end which is drawn to the exact endpoint of the line. */ MGLLineCapButt, /** A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line. */ MGLLineCapRound, /** A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width. */ MGLLineCapSquare, }; /** The display of lines when joining. Values of this type are used in the `MGLLineStyleLayer.lineJoin` property. */ typedef NS_ENUM(NSUInteger, MGLLineJoin) { /** A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width. */ MGLLineJoinBevel, /** A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line. */ MGLLineJoinRound, /** A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet. */ MGLLineJoinMiter, }; /** Controls the translation reference point. Values of this type are used in the `MGLLineStyleLayer.lineTranslationAnchor` property. */ typedef NS_ENUM(NSUInteger, MGLLineTranslationAnchor) { /** The line is translated relative to the map. */ MGLLineTranslationAnchorMap, /** The line is translated relative to the viewport. */ MGLLineTranslationAnchorViewport, }; /** An `MGLLineStyleLayer` is a style layer that renders one or more stroked polylines on the map. Use a line style layer to configure the visual appearance of polyline or multipolyline features in vector tiles loaded by an `MGLVectorSource` object or `MGLPolyline`, `MGLPolylineFeature`, `MGLMultiPolyline`, or `MGLMultiPolylineFeature` instances in an `MGLShapeSource` object. You can access an existing line 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 line style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. ### Example ```swift let layer = MGLLineStyleLayer(identifier: "trails-path", source: trails) layer.sourceLayerIdentifier = "trails" layer.lineWidth = MGLStyleValue(interpolationMode: .exponential, cameraStops: [14: MGLStyleValue(rawValue: 2), 18: MGLStyleValue(rawValue: 20)], options: [.interpolationBase: 1.5]) layer.lineColor = MGLStyleValue(rawValue: .brown) layer.lineCap = MGLStyleValue(rawValue: NSValue(mglLineCap: .round)) layer.predicate = NSPredicate(format: "%K == %@", "trail-type", "mountain-biking") mapView.style?.addLayer(layer) ``` */ MGL_EXPORT @interface MGLLineStyleLayer : MGLVectorStyleLayer /** Returns a line 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. @param identifier A string that uniquely identifies the source in the style to which it is added. @param 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 An initialized foreground style layer. */ - (instancetype)initWithIdentifier:(NSString *)identifier source:(MGLSource *)source; #pragma mark - 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. You can set this property to an instance of: * `MGLConstantStyleValue` * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *lineCap; /** 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. You can set this property to an instance of: * `MGLConstantStyleValue` * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *lineJoin; /** 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. You can set this property to an instance of: * `MGLConstantStyleValue` * `MGLCameraStyleFunction` with an interpolation mode of: * `MGLInterpolationModeExponential` * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *lineMiterLimit; /** 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. You can set this property to an instance of: * `MGLConstantStyleValue` * `MGLCameraStyleFunction` with an interpolation mode of: * `MGLInterpolationModeExponential` * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *lineRoundLimit; #pragma mark - Accessing the Paint Attributes /** 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. 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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineBlur; /** The transition affecting any changes to this layer’s `lineBlur` property. This property corresponds to the `line-blur-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineBlurTransition; #if TARGET_OS_IPHONE /** 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. 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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineColor; #else /** The color with which the line will be drawn. 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 `linePattern` 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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineColor; #endif /** The transition affecting any changes to this layer’s `lineColor` property. This property corresponds to the `line-color-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineColorTransition; /** 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. This attribute corresponds to the line-dasharray layout property in the Mapbox Style Specification. You can set this property to an instance of: * `MGLConstantStyleValue` * `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *> *lineDashPattern; /** The transition affecting any changes to this layer’s `lineDashPattern` property. This property corresponds to the `line-dasharray-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineDashPatternTransition; @property (nonatomic, null_resettable) MGLStyleValue *> *lineDasharray __attribute__((unavailable("Use lineDashPattern instead."))); /** 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. 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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineGapWidth; /** The transition affecting any changes to this layer’s `lineGapWidth` property. This property corresponds to the `line-gap-width-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineGapWidthTransition; /** 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. 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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineOffset; /** The transition affecting any changes to this layer’s `lineOffset` property. This property corresponds to the `line-offset-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineOffsetTransition; /** 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. 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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineOpacity; /** The transition affecting any changes to this layer’s `lineOpacity` property. This property corresponds to the `line-opacity-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineOpacityTransition; /** Name of image in style images to use for drawing image lines. For seamless patterns, image width 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` */ @property (nonatomic, null_resettable) MGLStyleValue *linePattern; /** The transition affecting any changes to this layer’s `linePattern` property. This property corresponds to the `line-pattern-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition linePatternTransition; #if TARGET_OS_IPHONE /** 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 downward. Set this property to `nil` to reset it to the default value. This attribute corresponds to the line-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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineTranslation; #else /** 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 line-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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineTranslation; #endif /** The transition affecting any changes to this layer’s `lineTranslation` property. This property corresponds to the `line-translate-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineTranslationTransition; @property (nonatomic, null_resettable) MGLStyleValue *lineTranslate __attribute__((unavailable("Use lineTranslation instead."))); /** Controls the translation reference point. The default value of this property is an `MGLStyleValue` object containing an `NSValue` object containing `MGLLineTranslationAnchorMap`. Set this property to `nil` to reset it to the default value. This property is only applied to the style if `lineTranslation` is non-`nil`. Otherwise, it is ignored. This attribute corresponds to the line-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` */ @property (nonatomic, null_resettable) MGLStyleValue *lineTranslationAnchor; @property (nonatomic, null_resettable) MGLStyleValue *lineTranslateAnchor __attribute__((unavailable("Use lineTranslationAnchor instead."))); /** 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. You can set this property to an instance of: * `MGLConstantStyleValue` * `MGLCameraStyleFunction` with an interpolation mode of: * `MGLInterpolationModeExponential` * `MGLInterpolationModeInterval` */ @property (nonatomic, null_resettable) MGLStyleValue *lineWidth; /** The transition affecting any changes to this layer’s `lineWidth` property. This property corresponds to the `line-width-transition` property in the style JSON file format. */ @property (nonatomic) MGLTransition lineWidthTransition; @end /** Methods for wrapping an enumeration value for a style layer attribute in an `MGLLineStyleLayer` object and unwrapping its raw value. */ @interface NSValue (MGLLineStyleLayerAdditions) #pragma mark Working with Line Style Layer Attribute Values /** Creates a new value object containing the given `MGLLineCap` enumeration. @param lineCap The value for the new object. @return A new value object that contains the enumeration value. */ + (instancetype)valueWithMGLLineCap:(MGLLineCap)lineCap; /** The `MGLLineCap` enumeration representation of the value. */ @property (readonly) MGLLineCap MGLLineCapValue; /** Creates a new value object containing the given `MGLLineJoin` enumeration. @param lineJoin The value for the new object. @return A new value object that contains the enumeration value. */ + (instancetype)valueWithMGLLineJoin:(MGLLineJoin)lineJoin; /** The `MGLLineJoin` enumeration representation of the value. */ @property (readonly) MGLLineJoin MGLLineJoinValue; /** Creates a new value object containing the given `MGLLineTranslationAnchor` enumeration. @param lineTranslationAnchor The value for the new object. @return A new value object that contains the enumeration value. */ + (instancetype)valueWithMGLLineTranslationAnchor:(MGLLineTranslationAnchor)lineTranslationAnchor; /** The `MGLLineTranslationAnchor` enumeration representation of the value. */ @property (readonly) MGLLineTranslationAnchor MGLLineTranslationAnchorValue; @end NS_ASSUME_NONNULL_END