surgeZoneObject

Describes a zone within which some stop types are de-prioritised by a factor, via the stops attribute.

{

"id": <integer>,

"surge": <bool> | null,

"travelFactor": <real> | null,

"projectFactor": <real> | null,

"stops": [stopType: real],

"color": <string> | null,

}

id integer: Unique identifier for the surge zone.
surge bool: Switches the zone on or off.
zone zone: The circular region the surge applies to. null / absent = a "blanket" zone that Spiral applies everywhere (and which is never drawn on the map).
innerRadius distance: The effect tapers from the outer edge to the inner radius; within it the effect is maximal. null for a blanket zone.
travelFactor real: Factor affecting travel time within the inner zone, linearly interpolated back to 1.0 at the outer boundary.
projectFactor real: Factor affecting expected project demand within the inner zone, linearly interpolated back to 1.0 at the outer boundary.
stops [stopType: real]: Pairs stop types with delay-cost factors applied within the inner zone, linearly interpolated back to 1.0 at the outer boundary.
color string: Helix-only — a colours-palette name or CSS value used to render the zone on the map; never sent to Spiral.

Related