GoogleRidesharingConsumer Framework Reference

  • GMTCMutablePolylineStyleOptions is a mutable data object for customizing polyline properties.

  • You can adjust the polyline's appearance by setting strokeWidth, which controls the line's width, and strokeColor, which defines the line's color.

  • The visibility of the polyline is managed by the isVisible property, with a default value of YES.

  • The zIndex property, which defaults to 10, determines the polyline's layering order, and isGeodesic determines whether the polyline segments are straight or geodesic.

  • You can utilize isTrafficEnabled to manage the visibility of traffic data on the polyline, and set traffic colors for different speed types with setTrafficColorForSpeed:color:.

GMTCMutablePolylineStyleOptions

@interface GMTCMutablePolylineStyleOptions : GMTCPolylineStyleOptions

Mutable data object that holds polyline customization properties.

  • The width of the line stroke in screen points. If an invalid value is set here (less than 0.0f), then it will be set to the default value of 2.0f.

    Declaration

    Swift

    var strokeWidth: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat strokeWidth;

  • Used to specify the color of one or more segments of a polyline. If set to NULL, then it will be set to the default value of [UIColor blueColor].

    Declaration

    Swift

    @NSCopying var strokeColor: UIColor! { get set }

    Objective-C

    @property (nonatomic, copy, null_resettable) UIColor *strokeColor;

  • Boolean that determines the visibility of the polyline. Defaults to YES.

    Declaration

    Swift

    var isVisible: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL isVisible;

  • Value that determines the z index of the polyline. Defaults to 10.

    Declaration

    Swift

    var zIndex: Int32 { get set }

    Objective-C

    @property (nonatomic) int32_t zIndex;

  • Indicates whether the segments of the polyline should be drawn as geodesics, as opposed to straight lines on the Mercator projection.

    Declaration

    Swift

    var isGeodesic: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL isGeodesic;

  • Boolean that determines the visibility of the traffic polyline. Defaults to NO.

    Declaration

    Swift

    var isTrafficEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL isTrafficEnabled;

  • Sets the color for the given speed type. If color is set to NULL, then the default color for the speed type is used.

    Declaration

    Swift

    func setTrafficColorFor(_ speedType: GMTSSpeedType, color: UIColor?)

    Objective-C

    - (void)setTrafficColorForSpeed:(GMTSSpeedType)speedType
                          color:(nullable UIColor *)color;

    Parameters

    speedType

    The speed type to apply the color to.
    color

    The color to apply to the speed type.