Port Route Duration Annotations feature to Maps SDK v10 map styling API #2873

avi-c · 2021-03-17T19:42:57Z

Maps v10 replaced the old NSExpression-based style layer API with a new Expressions API.

This necessitates porting over the Route Durations Annotations to the new API.

avi-c · 2021-03-17T19:44:59Z

Replaces #2870.

avi-c · 2021-03-17T19:45:48Z

Incorporated some of the feedback that @azarovalex included in #2870

1ec5

Looks like these are new commits atop release-v2.0 rather than a merge commit. That’s fine, but eventually we’ll need to perform a merge of main into release-v2.0. When we do that, we’ll be able to ignore any conflicts related to route duration annotations as long as this PR has already landed by then.

MapboxNavigation.xcodeproj/project.pbxproj

avi-c · 2021-03-19T20:52:04Z

@1ec5 - I think all the feedback is addressed. Would it be possible to approve this so we can merge it in?

avi-c · 2021-04-01T15:52:51Z

@1ec5 - Let me know if there is more to do here or if I can update and merge it in soon.

1ec5 · 2021-04-20T01:38:57Z

Sources/MapboxNavigation/DayStyle.swift

@@ -155,6 +162,11 @@ open class DayStyle: Style {
        NavigationMapView.appearance().trafficUnknownColor = .trafficUnknown
        NavigationMapView.appearance().buildingDefaultColor = .defaultBuildingColor
        NavigationMapView.appearance().buildingHighlightColor = .defaultBuildingHighlightColor
+        NavigationMapView.appearance().routeDurationAnnotationColor = .routeDurationAnnotationColor
+        NavigationMapView.appearance().routeDurationAnnotationSelectedColor = .selectedRouteDurationAnnotationColor
+        NavigationMapView.appearance().routeDurationAnnotationFontName = "DIN Pro Medium"


In general, when styling text on the map that we expect to render server-side, we need to specify a list of fonts including a fallback font. Otherwise, the fontstack could be missing glyphs that are required for rendering the street names, even if the same street names render just fine on the base map: mapbox/mapbox-maps-ios#278.

Since font selection for a symbol layer is so specific to the style specification and unlike UIKit/Core Text font selection, an immediate goal could be to match the fonts in the base style. Consider using the runtime styling API to get the textFont property of the symbol layer used to render roads (so the layer would have a source layer of road) and copying that expression to the layer for the annotations. Typically, a style will use multiple distinct fontstacks for various road label layers, but perhaps we could blithely pick the topmost matching layer or add heuristics to detect and ignore italics and boldface.

That said, maybe the current approach is fine, but there still needs to be a way to specify multiple fallback fonts. The downside is that a developer needs to digest these complex heuristics, especially if they end up opting into client-side fonts for CJK.

These are good points. I changed the code to allow for a list of font names to be used and not just a single one. This lets the developer choose fonts that may be present in their map style. Also changed the default font of DIN Pro Medium to also include Noto Sans CJK JP Medium and Arial Unicode MS Regular as fallbacks in order to support more glyphs "out of the box" with our default set.
I think that the use of UIAppearance overrides for these map rendered fonts is probably the clearest way we can allow for supporting multiple fonts and fallbacks. I think it's preferable to trying to locate the font settings of a specific layer in the style, which feels more hidden and brittle, even if the source layer name for roads, road is unlikely to change very often in mapbox-streets.

1ec5 · 2021-05-04T15:08:21Z

CHANGELOG.md

@@ -99,6 +99,9 @@
  * `NavigationMapViewDelegate.navigationMapView(_:alternativeRouteCasingStyleLayerWithIdentifier:source:)` to style the casing of alternative route.
 * Fixed an issue where the route line periodically peeked out from behind the user puck even though `NavigationViewController.routeLineTracksTraversal` was enabled. ([#2737](https://github.com/mapbox/mapbox-navigation-ios/pull/2737))
 * Created the `UserHaloCourseView` similar to `UserCourseView` for approximate location on iOS 14 during the navigation to represent user location. Allow the switch between `UserHaloCourseView` and `UserCourseView` when precise mode is changed. ([#2664](https://github.com/mapbox/mapbox-navigation-ios/pull/2664))
+* Added option to show route duration callouts when previewing route alternatives ([#2734](https://github.com/mapbox/mapbox-navigation-ios/pull/2734)):
+  * `NavigationMapView.showRouteDurations(along routes:)` to show duration annotation callouts on the map for the provided routes.


Suggested change

* `NavigationMapView.showRouteDurations(along routes:)` to show duration annotation callouts on the map for the provided routes.

* `NavigationMapView.showRouteDurations(along:)` to show duration annotation callouts on the map for the provided routes.

CHANGELOG.md

Sources/MapboxNavigation/NavigationMapView.swift

Sources/MapboxNavigation/DayStyle.swift

Sources/MapboxNavigation/NavigationMapView.swift

1ec5 · 2021-05-04T15:18:03Z

Sources/MapboxNavigation/NavigationMapView.swift

+    @objc dynamic public var routeDurationAnnotationColor: UIColor = .routeDurationAnnotationColor
+    @objc dynamic public var routeDurationAnnotationSelectedTextColor: UIColor = .selectedRouteDurationAnnotationTextColor
+    @objc dynamic public var routeDurationAnnotationTextColor: UIColor = .routeDurationAnnotationTextColor
+    @objc dynamic public var routeDurationAnnotationFontName: [String] = ["DIN Pro Medium", "Noto Sans CJK JP Medium", "Arial Unicode MS Regular"]


I still think a better default behavior should be to match the style’s existing road label fontstack, even if this UIAppearance option remains as an override. But routeDurationAnnotationFontName is not new, so this can be tail work.

I'm not totally convinced, but I do think you have a good point in that not picking up the map style's font stack removes the ability of the map designer from changing this without help from engineering.

I wrote up #2994 to track this later change.

Sources/MapboxNavigation/NavigationMapView.swift

1ec5 · 2021-05-11T17:53:57Z

CHANGELOG.md

@@ -63,6 +63,8 @@
 * Added the `Directions.calculateOffline(options:completionHandler:)` and `Directions.calculateWithCache(options:completionHandler:)` methods, which incorporate routing tiles from the predictive cache when possible to avoid relying on a network connection to calculate the route. `RouteController` now also uses the predictive cache when rerouting. ([#2848](https://github.com/mapbox/mapbox-navigation-ios/pull/2848)) 
 * Fixed an issue where `PassiveLocationDataSource` and `RouteController` did not use the access token and host specified by `PassiveLocationDataSource.directions` and `RouteController.directions`, respectively. Added the `PredictiveCacheOptions.credentials` property for specifying the access token and host used for prefetching resources. ([#2876](https://github.com/mapbox/mapbox-navigation-ios/pull/2876))
 * The top banner can now show a wider variety of turn lane configurations, such as combination U-turn/left turn lanes and combination through/slight right turn lanes. ([#2882](https://github.com/mapbox/mapbox-navigation-ios/pull/2882))
+* Route Duration Annotations feature now supports a list of fonts to be used. This allows for fallback fonts to be specified and more languages to be supported.  ([#2873](https://github.com/mapbox/mapbox-navigation-ios/pull/2873)):


Suggested change

* Route Duration Annotations feature now supports a list of fonts to be used. This allows for fallback fonts to be specified and more languages to be supported. ([#2873](https://github.com/mapbox/mapbox-navigation-ios/pull/2873)):

* The duration annotations added by the `NavigationMapView.showRouteDurations(along:)` method are now set in the fonts you specify using the `NavigationMapView.routeDurationAnnotationFontNames` property. Use this property to specify a list of fallback fonts for better language support. ([#2873](https://github.com/mapbox/mapbox-navigation-ios/pull/2873)):

CHANGELOG.md

Sources/MapboxNavigation/DayStyle.swift

Sources/MapboxNavigation/NavigationMapView.swift

1ec5 · 2021-05-11T17:58:46Z

Sources/MapboxNavigation/DayStyle.swift

+    /**
+     List of Mapbox Maps font names to be used for any symbol layers added by the Navigation SDK.
+     These are used for features such as Route Duration Annotations that are optionally added during route preview.
+     See https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html for more information about server-side fonts.


Where will the (not terribly intuitive) font fallback behavior be documented for map SDK v10? Will it be in the v10 API reference or a guide on docs.mapbox.com?

/cc @mapbox/docs

That is a very good question. I looked for the font documentation in the v10 beta documentation and it isn't present. I went with the less desired approach of mentioning the v6.3 documentation until the place in the v10 documentation is sorted out.

Perhaps I should write a ticket to update this comment when the docs for Maps v10 are finalized.

1ec5 · 2021-05-11T19:55:37Z

Sources/MapboxNavigation/NavigationMapView.swift

+     These are used for features such as Route Duration Annotations that are optionally added during route preview.
+     See https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html for more information about server-side fonts.


Use Markdown formatting:

Suggested change

These are used for features such as Route Duration Annotations that are optionally added during route preview.

See https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html for more information about server-side fonts.

This property affects the font applied to the route duration annotations that the `showRouteDurations(along:)` method adds to the map view. [The map view selects the font](https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html) in the same manner as any other symbol layer that you add to the style.

…hable areas to match new images.

… instead of a single font name to allow for font fallbacks. Specify a longer list of fonts to include fallbacks for non-English glyphs.

…s set on the Navigation View. In theory they may not be the same, particularly if the developer only wants to label a subset of the routes.

… where the passed route list was ignored in favor of the active list in the NavigationMapView.

1ec5 · 2021-05-12T15:49:01Z

Sources/MapboxNavigation/NavigationMapView.swift

+        let symbolSortKeyString =
+        """
+        ["get", "sortOrder"]
+        """
+
+        if let expressionData = symbolSortKeyString.data(using: .utf8), let expJSONObject = try? JSONSerialization.jsonObject(with: expressionData, options: []) {
+
+            mapView.mapboxMap.__map.setStyleLayerPropertyForLayerId(NavigationMapView.routeDurationAnnotationsLayerIdentifier,
+                                                          property: "symbol-sort-key",
+                                                          value: expJSONObject)
+        }


I overlooked the possibility of using Expression here: #2996.

avi-c mentioned this pull request Mar 17, 2021

Port Route Duration Annotations feature to Maps SDK v10 map styling API #2870

Closed

1ec5 requested a review from azarovalex March 18, 2021 16:04

1ec5 assigned avi-c Mar 18, 2021

1ec5 added - chore op-ex Refactoring, Tech Debt or any other operational excellence work. topic: cartography release blocker Needs to be resolved before the release. labels Mar 18, 2021

1ec5 added this to the v2.0.0 (RC) milestone Mar 18, 2021

1ec5 reviewed Mar 18, 2021

View reviewed changes

MapboxNavigation.xcodeproj/project.pbxproj Outdated Show resolved Hide resolved

1ec5 mentioned this pull request Apr 6, 2021

Route alternatives should include a callout showing estimated duration of each route #2702

Closed

1ec5 linked an issue Apr 6, 2021 that may be closed by this pull request

Route alternatives should include a callout showing estimated duration of each route #2702

Closed

1ec5 reviewed Apr 20, 2021

View reviewed changes

avi-c force-pushed the ac-RouteDurationAnnotations branch 2 times, most recently from 65d42c3 to 01669ab Compare April 25, 2021 23:27

1ec5 reviewed May 4, 2021

View reviewed changes

avi-c mentioned this pull request May 11, 2021

Text layers from Nav SDK should pick up font stack from map style road label layer #2994

Open

1ec5 reviewed May 11, 2021

View reviewed changes

1ec5 approved these changes May 11, 2021

View reviewed changes

avi-c added 7 commits May 11, 2021 14:15

Port Route Duration Annotation work to Maps v10 styling API.

ff97e17

Switch Annotation image assets to PDFs instead of PNGs. Adjust stretc…

062bdd2

…hable areas to match new images.

Incorporate some review feedback to simplify a couple of functions.

48c56ff

Remove unnecessary CHANGELOG line.

e6e85e7

Remove use of MGL prefix from new file.

3ab705d

Rebase to current. Change Route Duration font property to be an array…

3e04214

… instead of a single font name to allow for font fallbacks. Specify a longer list of fonts to include fallbacks for non-English glyphs.

Use the supplied routes when adding route annotations and not the one…

8f45e5f

…s set on the Navigation View. In theory they may not be the same, particularly if the developer only wants to label a subset of the routes.

avi-c added 5 commits May 11, 2021 14:15

Fix merge conflict and update rebase to latest.

f0f5eec

Respond to review feedback. Fix issue with showRouteDurations(along:)…

1557930

… where the passed route list was ignored in favor of the active list in the NavigationMapView.

Revert changes to showRoutes() function.

b11e72e

Incorporate review feedback for documentation changes.

ad2b88f

Rebase to latest release-v2.0

1680bfa

avi-c force-pushed the ac-RouteDurationAnnotations branch from 5045ee2 to 1680bfa Compare May 11, 2021 21:31

avi-c merged commit 9a7124d into release-v2.0 May 11, 2021

avi-c deleted the ac-RouteDurationAnnotations branch May 11, 2021 22:46

1ec5 mentioned this pull request May 12, 2021

Route duration annotation styling should use Expressions, not JSON #2996

Closed

1ec5 reviewed May 12, 2021

View reviewed changes

This was referenced May 17, 2022

Annotate intersecting roads and maneuver points along the current route #2928

Open

Migrate image tinting to UIGraphicsImageRenderer #3893

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port Route Duration Annotations feature to Maps SDK v10 map styling API #2873

Port Route Duration Annotations feature to Maps SDK v10 map styling API #2873

avi-c commented Mar 17, 2021

avi-c commented Mar 17, 2021

avi-c commented Mar 17, 2021

1ec5 left a comment

avi-c commented Mar 19, 2021

avi-c commented Apr 1, 2021

1ec5 Apr 20, 2021 •

edited

Loading

avi-c Apr 20, 2021

1ec5 May 4, 2021

avi-c May 11, 2021

1ec5 May 4, 2021

avi-c May 11, 2021

1ec5 May 11, 2021

1ec5 May 11, 2021

avi-c May 11, 2021

1ec5 May 11, 2021

1ec5 May 12, 2021

	* `NavigationMapView.showRouteDurations(along routes:)` to show duration annotation callouts on the map for the provided routes.
	* `NavigationMapView.showRouteDurations(along:)` to show duration annotation callouts on the map for the provided routes.

	* Route Duration Annotations feature now supports a list of fonts to be used. This allows for fallback fonts to be specified and more languages to be supported. ([#2873](https://github.com/mapbox/mapbox-navigation-ios/pull/2873)):
	* The duration annotations added by the `NavigationMapView.showRouteDurations(along:)` method are now set in the fonts you specify using the `NavigationMapView.routeDurationAnnotationFontNames` property. Use this property to specify a list of fallback fonts for better language support. ([#2873](https://github.com/mapbox/mapbox-navigation-ios/pull/2873)):

		These are used for features such as Route Duration Annotations that are optionally added during route preview.
		See https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html for more information about server-side fonts.

	These are used for features such as Route Duration Annotations that are optionally added during route preview.
	See https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html for more information about server-side fonts.
	This property affects the font applied to the route duration annotations that the `showRouteDurations(along:)` method adds to the map view. [The map view selects the font](https://docs.mapbox.com/ios/maps/api/6.3.0/customizing-fonts.html) in the same manner as any other symbol layer that you add to the style.

Port Route Duration Annotations feature to Maps SDK v10 map styling API #2873

Port Route Duration Annotations feature to Maps SDK v10 map styling API #2873

Conversation

avi-c commented Mar 17, 2021

avi-c commented Mar 17, 2021

avi-c commented Mar 17, 2021

1ec5 left a comment

Choose a reason for hiding this comment

avi-c commented Mar 19, 2021

avi-c commented Apr 1, 2021

1ec5 Apr 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 Apr 20, 2021 •

edited

Loading