AttributeOptions

Attributes are metadata information for a route leg.

When any of the attributes are specified, the resulting route leg contains one attribute value for each segment in leg, where a segment is the straight line between two coordinates in the route leg’s full geometry.

  • Live-traffic closures along the road segment.

    When this attribute is specified, the RouteLeg.closures property is filled with relevant data.

    This attribute requires ProfileIdentifier.automobileAvoidingTraffic and is supported only by Directions and Map Matching requests.

  • Distance (in meters) along the segment.

    When this attribute is specified, the RouteLeg.segmentDistances property contains one value for each segment in the leg’s full geometry. When used in Matrix request - will produce a distances matrix in response.

  • Expected travel time (in seconds) along the segment.

    When this attribute is specified, the RouteLeg.expectedSegmentTravelTimes property contains one value for each segment in the leg’s full geometry. When used in Matrix request - will produce a durations matrix in response.

  • Current average speed (in meters per second) along the segment.

    When this attribute is specified, the RouteLeg.segmentSpeeds property contains one value for each segment in the leg’s full geometry. This attribute is supported only by Directions and Map Matching requests.

  • Traffic congestion level along the segment.

    When this attribute is specified, the RouteLeg.congestionLevels property contains one value for each segment in the leg’s full geometry.

    This attribute requires ProfileIdentifier.automobileAvoidingTraffic and is supported only by Directions and Map Matching requests. Any other profile identifier produces CongestionLevel.unknown for each segment along the route.

  • The maximum speed limit along the segment.

    When this attribute is specified, the RouteLeg.segmentMaximumSpeedLimits property contains one value for each segment in the leg’s full geometry. This attribute is supported only by Directions and Map Matching requests.

  • Traffic congestion level in numeric form.

    When this attribute is specified, the RouteLeg.numericCongestionLevels property contains one value for each segment in the leg’s full geometry.

    This attribute requires ProfileIdentifier.automobileAvoidingTraffic and is supported only by Directions and Map Matching requests. Any other profile identifier produces nil for each segment along the route.

  • Creates an AttributeOptions from the given description strings.