TomTom Maps SDK for JavaScript
This is the documentation of version 0.62.1. 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;
    }

    Route section affected by a traffic incident.

    Represents a portion of the route experiencing traffic delays due to congestion, accidents, construction, or other incidents.

    Type Declaration

    • categories: TrafficIncidentCategory[]

      Categories of the incident. Based on the 'tec' cause codes.

    • OptionaldelayInSeconds?: number

      Additional delay in seconds caused by this incident.

      Extra time compared to free-flow conditions. Present when delay can be calculated.

    • OptionaleffectiveSpeedInKmh?: number

      Actual average speed through this incident in km/h.

      Present when speed information is available. Lower speeds indicate worse congestion.

    • OptionaleventId?: string

      The identifier of the traffic incident behind this section.

      This is the join key back to the full incident: pass it to the traffic incident details service to get the whole record, rather than re-deriving it from the section's geometry.

    • magnitudeOfDelay: DelayMagnitude

      Severity level of the delay caused by this incident.

    • tec: TrafficIncidentTEC

      TPEG2-TEC standardized incident information.

      Provides internationally standardized codes for traffic incident classification.

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

    Settings
    Member Visibility