This is the documentation of version 1.0.0-rc.2. Go to the latest version, 1.0.0-rc.5.

Type Alias TrafficIncidentsModuleConfig

TrafficIncidentsModuleConfig: MapModuleCommonConfig & {
    colors?: TrafficIncidentColors;
    filters?: TrafficIncidentsFilters;
    icons?: IncidentIconsConfig;
    timeValidity?: TrafficIncidentTimeValidity[];
    visible?: boolean;
    widthFactor?: number;
}

Configuration for traffic incidents module.

Type Declaration

Optionalcolors?: TrafficIncidentColors

The colours of the incident lines, per delay magnitude.
Optionalfilters?: TrafficIncidentsFilters

Which incidents are shown, by category, severity, delay and road type, for lines and icons alike.
Optionalicons?: IncidentIconsConfig

Configuration specific to the incident icons.
OptionaltimeValidity?: TrafficIncidentTimeValidity[]

Which incidents the tiles bring, by when they occur: present ones are under way, future ones are planned, such as scheduled roadworks.
Remarks
Unlike filters, this changes the tile request, so a change reloads the incident tiles. Unset or empty, only the present incidents come.
Example
```
// Planned incidents only
timeValidity: ['future']
```
Default
```
['present']
```
Optionalvisible?: boolean

Whether the traffic incident layers are visible, icons included.
Default
```
false
```
OptionalwidthFactor?: number

Width multiplier for the incident lines, where 1 is the style's own.
Default
```
1
```

Remarks

One set of filters narrows both the incident lines and their icons. icons only decides whether the icons are shown.