Maps SDK for Web

tt.services.trafficFlowSegmentData

The Flow Segment Data service provides information about the speeds and travel times of the road fragment closest to the given coordinates.

Response

The response is extended with getTrackingId() method, which returns the Tracking-ID associated with the request.

Please refer to Difference between API responses and this library's responses section.

Constructor

tt.services.trafficFlowSegmentData(options, [additionalOptions])

Parameters
Name Description
options
Object
default:None 		Options to be passed to the flowSegmentData call.
additionalOptions
Object
default:None 		Additional options to be passed to the service.
additionalOptions.abortSignal
Object
default:None

Signal created with abortController.


Use AbortController to cancel requests in progress.
Example
var abortController = new AbortController();
var options = {};
tt.services.calculateRoute(options, { abortSignal: abortController.signal })
    .then(function(response) { console.log(response) });
    .catch(function(error) {
        if (abortController.signal.aborted === true) {
            console.log('Request aborted.');
        }
    });
abortController.abort();
options.key
String
default:None

A valid API Key for the requested service.


Key is required to make use of the given service. It can be issued in the Developer Portal.
options.openLr
Boolean
default:None

Specifies if the Response includes OpenLR code.
options.point
String
default:None

Coordinates of the point close to the road segment. They have to be comma-separated and calculated using the EPSG4326 projection.
options.style
String
default:None

The type of flow data to be displayed on the tile. Available options: absolute, relative, and relative-delay.
options.thickness
Number
default:None

The segment width multiplier. Value should be in the range from 1 to 20.
options.trackingId
String
default:uuid

Sets value of "Tracking-ID" header.


Specifies an identifier for the request. If not set by the user, UUID is generated for each call.
  • It can be used to trace a call.
  • The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.
  • An example of the format that matches this regular expression is UUID: (e.g. 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1). For details check RFC 4122.
  • If specified, it is replicated in the Tracking-ID Response header.
  • It is only meant to be used for support and does not involve tracking of you or your users in any form.
options.unit
String
default:None

Unit of speed. Avilable values: KMPH and MPH.
options.zoom
Number
default:None

Zoom level. This will affect traffic incident coordinates to separately present both road sides. Should be in the range from 0 to 18.

Methods