This is the documentation of version 0.63.0. Go to the latest version, 1.0.0-rc.5.

Function buildWaypointTitle

buildWaypointTitle(waypoint: Waypoint): string | undefined

The label RoutingModule gives a waypoint when WaypointLabelConfig.title is not a function: the POI name, else the free-form address, else none.

Parameters

waypoint: Waypoint

Returns string | undefined

Example

// "Home" at the finish, the default label elsewhere
routingModule.applyConfig({
  waypoints: {
    label: {
      title: (waypoint) =>
        waypoint.properties.indexType === 'finish' ? 'Home' : (buildWaypointTitle(waypoint) ?? ''),
    },
  },
});