GoogleMaps Framework Reference

AI-generated Key Takeaways

• GMSPolyline is an object used to represent a line drawn on a map, defined by a series of points called a path.

• You can customize the appearance of the polyline, such as its color, width, and whether it follows the Earth's curvature (geodesic).

• Polylines can have styled segments using GMSStyleSpan allowing for variations in color or other visual properties along the line's length.

• If no style spans are provided, the entire polyline is rendered with the strokeColor property, defaulting to blue.

• A convenience constructor polylineWithPath: simplifies the creation of a basic polyline with default settings.

GMSPolyline

@interface GMSPolyline : GMSOverlay

GMSPolyline specifies the available options for a polyline that exists on the Earth’s surface. It is drawn as a physical line between the points specified in path.

• path

  The path that describes this polyline.

  Declaration

  Swift

  @NSCopying var path: GMSPath? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) GMSPath *path;

• strokeWidth

  The width of the line in screen points. Defaults to 1.

  Declaration

  Swift

  var strokeWidth: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat strokeWidth;

• strokeColor

  The UIColor used to render the polyline. Defaults to [UIColor blueColor].

  Declaration

  Swift

  var strokeColor: UIColor { get set }

  Objective-C

  @property (nonatomic) UIColor *_Nonnull strokeColor;

• geodesic

  Whether this line should be rendered with geodesic correction.

  Declaration

  Swift

  var geodesic: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL geodesic;

• +polylineWithPath:

  Convenience constructor for GMSPolyline for a particular path. Other properties will have default values.

  Declaration

  Swift

  convenience init(path: GMSPath?)

  Objective-C

  + (nonnull instancetype)polylineWithPath:(nullable GMSPath *)path;

• spans

  An array containing GMSStyleSpan, the spans used to render this polyline.

  If this array contains fewer segments than the polyline itself, the final segment will be applied over the remaining length. If this array is unset or empty, then strokeColor is used for the entire line instead.

  Declaration

  Swift

  var spans: [GMSStyleSpan]? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSArray<GMSStyleSpan *> *spans;