Class TrafficEvent

Traffic events class

Hierarchy (View Summary)

GemAutoreleaseObject
- TrafficEvent
  - RouteTrafficEvent

Index

Constructors

Properties

_mapId _pointerId

Accessors

boundingBox delay description endTime eventClass eventSeverity hasOppositeSibling impactZone isRoadblock isUserRoadblock length mapId pointerId previewUrl referencePoint startTime

Methods

dispose getImage registerAutoReleaseObject init

Constructors

constructor

new TrafficEvent(id?: number, mapId?: number): TrafficEvent
Parameters
- id: number = -1
- mapId: number = -1
Returns TrafficEvent
Overrides GemAutoreleaseObject.constructor
- Defined in core/traffic.ts:24

Properties

`Protected`_mapId

_mapId: number

`Protected`_pointerId

_pointerId: number

Accessors

boundingBox

get boundingBox(): RectangleGeographicArea
Gets the bounding box of the traffic event.

Returns RectangleGeographicArea
The bounding box
- Defined in core/traffic.ts:114

delay

get delay(): number
Gets the estimated delay in seconds caused by the traffic event.

Returns number
The delay in seconds. Returns -1 if the delay is unknown.
- Defined in core/traffic.ts:62

description

get description(): string
Gets the traffic event description

Returns string
The description
- Defined in core/traffic.ts:127

endTime

get endTime(): Date | null
Gets end time (UTC)

Returns Date | null
The end time if it is available, otherwise null.
- Defined in core/traffic.ts:259

eventClass

get eventClass(): TrafficEventClass
Gets the traffic event class

Returns TrafficEventClass
The event class
- Defined in core/traffic.ts:140

eventSeverity

get eventSeverity(): TrafficEventSeverity
Gets the traffic event severity

Returns TrafficEventSeverity
The event severity
- Defined in core/traffic.ts:153

hasOppositeSibling

get hasOppositeSibling(): boolean
Checks if event has a sibling on opposite direction

Returns boolean
True if the event has a sibling on opposite direction, false otherwise.
- Defined in core/traffic.ts:276

impactZone

get impactZone(): TrafficEventImpactZone
Gets the traffic event impact zone

Returns TrafficEventImpactZone
The impact zone type
- Defined in core/traffic.ts:88

isRoadblock

get isRoadblock(): boolean
Checks if this traffic event is a roadblock.

Returns boolean
True if the traffic event is a roadblock.
- Defined in core/traffic.ts:49

isUserRoadblock

get isUserRoadblock(): boolean
Return true if the traffic event is a user roadblock

Returns boolean
True if the traffic event is a user roadblock, false otherwise.
- Defined in core/traffic.ts:208

length

get length(): number
Gets the length in meters of the road segment affected by the traffic event.

Returns number
The length in meters.
- Defined in core/traffic.ts:75

mapId

get mapId(): number
Returns number
- Defined in core/traffic.ts:41

pointerId

get pointerId(): number
Returns number
- Defined in core/traffic.ts:37

previewUrl

get previewUrl(): string
Gets the traffic event preview URL

Returns string
The preview URL
- Defined in core/traffic.ts:195

referencePoint

get referencePoint(): Coordinates
Gets the traffic event reference point

Returns Coordinates
The reference point
- Defined in core/traffic.ts:101

startTime

get startTime(): Date | null
Gets start time (UTC)

Returns Date | null
The start time if it exists, otherwise null.
- Defined in core/traffic.ts:242

Methods

dispose

dispose(): void
Returns void
- Defined in core/traffic.ts:285

getImage

getImage(
size?: { height: number; width: number },
format?: ImageFileFormat,
): Uint8Array<ArrayBufferLike> | null
Gets the traffic event image
Parameters
- Optionalsize: { height: number; width: number }
  The size of the image
- Optionalformat: ImageFileFormat
  The image file format
Returns Uint8Array<ArrayBufferLike> | null
The traffic event image as Uint8Array or null
- Defined in core/traffic.ts:168

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14

`Static`init

init(id: number, mapId: number): TrafficEvent
Parameters
- id: number
- mapId: number
Returns TrafficEvent
- Defined in core/traffic.ts:33