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.

Constructor

tt.services.trafficFlowSegmentData(options)

Parameters
Name Description
options
Object
default:None 		Options to be passed to the flowSegmentData call.
options.point
String
default:None 		Coordinates of the point close to the road segment.
options.key
String
default:None 		Traffic Flow API Key that can be obtained from TomTom's Developer Portal.
options.style
String
default:None 		The type of flow data to be displayed on the tile. Available options: absolute, relative, relative-delay.
options.zoom
Number
default:None 		Zoom level. This will affect traffic incident coordinates to separately present both road sides.
options.unit
String
default:KMPH 		Unit of speed. Available options: KMPH, MPH.
options.thickness
Number
default:10 		Segment width multiplier. Accepts values in the range from 0 to 20.
options.key
String
default:None

A valid API Key for the requested service.


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

Specifies if the response includes OpenLR code.
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.
style
String
default:None

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

Segment width multiplier. Value should be in the range from 1 to 20.
unit
String
default:None

Unit of speed. Avilable values: KMPH, MPH.
zoom
Integer
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

go( ): Promise

Executes a predefined asynchronous task using the current configuration.

Returns