TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.4. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias TrafficSectionProps

    TrafficSectionProps: SectionProps & {
        categories: TrafficIncidentCategory[];
        delayInSeconds?: number;
        effectiveSpeedInKmh?: number;
        eventId?: string;
        magnitudeOfDelay: DelayMagnitude;
        tec?: TrafficIncidentTEC;
    }

    A route section affected by a traffic incident.

    It is a portion of the route with traffic delays due to congestion, accidents, construction or other incidents.

    Type Declaration

    • categories: TrafficIncidentCategory[]

      The categories of the incident, based on its tec cause codes, or on its icon category when it has none.

    • OptionaldelayInSeconds?: number

      The extra time in seconds this incident causes compared to free-flow conditions.

      It is present when the delay can be calculated.

    • OptionaleffectiveSpeedInKmh?: number

      The actual average speed through this incident in km/h, when speed information is available.

      A lower speed means worse congestion.

    • OptionaleventId?: string

      The routing service's identifier of the traffic incident behind this section.

      It is the tail of the incident's id in trafficIncidentDetails, not that id, so passing it as ids finds nothing. To get the whole record, query trafficIncidentDetails with the section's getSectionBBox and keep the incident whose id.endsWith(eventId).

    • magnitudeOfDelay: DelayMagnitude

      The severity of the delay this incident causes.

    • Optionaltec?: TrafficIncidentTEC

      The internationally standardized TPEG2-TEC codes that classify the incident, when the service has them.

    const trafficSection: TrafficSectionProps = {
      id: 'traffic-1',
      startPointIndex: 50,
      endPointIndex: 75,
      categories: ['jam'],
      magnitudeOfDelay: 'moderate',
      delayInSeconds: 420,  // 7 minutes
      effectiveSpeedInKmh: 25,
      tec: { effectCode: 1, causes: [{ mainCauseCode: 101 }] }
    };

    Settings
    Member Visibility