Migration for Android Consumer SDK v1.0 Customization

Marker Customization

In earlier versions of the Consumer SDK, you used Consumer SDK’s MarkerStyleOptions object to customize marker style properties. In Consumer SDK v1.0, you directly use the MarkerOptions object from the Maps SDK.

// Centering the marker anchor at (0.5, 0.5) is recommended.
// For vehicle markers, set flat to true to allow the vehicle marker to freely
// rotate flat on the map (rather than always have it face the camera).
MarkerOptions vehicleMarkerOptions = new MarkerOptions()
    .flat(true)
    .anchor(0.5f, 0.5f)
    .icon(vehicleIcon)
    .zIndex(1.0f);
consumerMapStyle.setMarkerStyleOptions(MarkerType.TRIP_VEHICLE);

Note: With the deprecation of MarkerStyleOptions along with its default style settings, Consumer SDK defines its own default style settings for each marker or polyline type and will not use the default style settings included in MarkerOptions.

ConsumerMapStyle returns the SDK-specified default style options for a given marker type if the style has not yet been set or if the style options has been set to null.

// ConsumerMapStyle returns the SDK-set default style options if none has been set yet.
MarkerOptions defaultPickupPointStyleOptions = consumerMapStyle.getMarkerStyleOptions(MarkerType.PICKUP_POINT);

// Setting the style to null reverts the style back to the SDK-set default properties.
consumerMapStyle.setMarkerStyleOptions(MarkerType.PICKUP_POINT, /* markerStyleOptions= */ null);
MarkerOptions defaultPickupPointStyleOptions = consumerMapStyle.getMarkerStyleOptions(MarkerType.PICKUP_POINT);

If you don't want to create a new style from scratch, you can modify the default style. The following example modifies only the pickup icon and uses the SDK's default settings for the rest of the marker options.

// getMarkerStyleOptions returns the default pickup point style options, since
// the custom style hasn't been set yet.
MarkerOptions pickupPointStyleOptions =
  consumerMapStyle.getMarkerStyleOptions(MarkerType.PICKUP_POINT);
// Modify the icon value and set the style.
consumerMapStyle.setMarkerStyleOptions(
  pickupPointStyleOptions.icon(pickupPointIcon));

Polyline Customization

In earlier versions of the Consumer SDK, you used Consumer SDK’s PolylineStyleOptions object to customize polyline style properties. In Consumer SDK v1.0, you use the PolylineOptions object from Maps SDK to customize the base polyline style properties and the TrafficStyle object to customize polyline traffic colors.

Traffic polylines are available in the alpha variant of the Consumer SDK v1.0 If traffic is visible, the base polyline color is overridden by the traffic colors. Traffic is not visible by default. Fields in TrafficStyle that are not set are filled in by SDK-specified default values.

// PolylineOptions is from Maps SDK
PolylineOptions polylineOptions = new PolylineOptions()
  .color(color)
  .width(width)
  .geodesic(geodesic)
  .startCap(startCap)
  .endCap(endCap)
  .zIndex(zIndex);
consumerMapStyle.setPolylineStyleOptions(
  PolylineType.ACTIVE_ROUTE, polylineOptions);

// TrafficStyle is from ConsumerSDK
TrafficStyle trafficStyle = TrafficStyle.builder()
  .setTrafficVisibility(true)
  .setTrafficColor(SpeedType.NO_DATA, Color.GREY)
  .setTrafficColor(SpeedType.NORMAL_VALUE, Color.BLUE)
  .setTrafficColor(SpeedType.SLOW_VALUE, Color.ORANGE)
  .setTrafficColor(SpeedType.TRAFFIC_JAM, Color.RED)
  .build();
consumerMapStyle.setPolylineTrafficStyle(PolylineType.ACTIVE_ROUTE, trafficStyle);

ConsumerMapStyle returns the SDK's default style options for a given polyline type if none has yet been set, or if style options are set to null. This applies to both the base PolylineOptions and the TrafficStyle.

// ConsumerMapStyle returns the SDK's default style options if none has been set yet.
PolylineOptions defaultActiveRouteStyleOptions = consumerMapStyle.getPolylineStyleOptions(PolylineType.ACTIVE_ROUTE);

// Setting the style to null reverts the style back to the SDK-set default properties.
consumerMapStyle.setPolylineStyleOptions(
  PolylineType.ACTIVE_ROUTE, /* polylineStyleOptions= */ null);
PolylineOptions defaultActiveRouteStyleOptions =
  consumerMapStyle.getPolylineStyleOptions(PolylineType.ACTIVE_ROUTE);

If you don't want to create a new style from scratch, you can modify the default style. The following example modifies only the base active route polyline color, and uses the SDK's default style settings for the rest of the marker options.

// Only customize the remaining route polyline color.
PolylineOptions remainingRouteStyleOptions =
     consumerMapStyle.getPolylineStyleOptions(PolylineType.REMAINING_ROUTE);
consumerMapStyle.setPolylineStyleOptions(
  remainingRouteStyleOptions.color(Color.DARK_BLUE));