DriverBehaviourAnalysis - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > DriverBehaviourAnalysis

DriverBehaviourAnalysis class

A driver behaviour analysis.

Provides methods for getting driver behaviour analysis data.

This class should not be instantiated directly. Instead, use the methods provided by the DriverBehaviour class.

Driver Behaviour

Signature:

export declare class DriverBehaviourAnalysis

Constructors

Constructor	Modifiers	Description
(constructor)()		Constructs a new instance of the `DriverBehaviourAnalysis` class

Properties

Property	Modifiers	Type	Description
drivingEvents	`readonly`	MappedDrivingEvent[]	Get all mapped driving events.
drivingScores	`readonly`	DrivingScores	Get scores for this session (partial and aggregate)
finishTime	`readonly`	number	Get the finish time of the session in milliseconds since epoch.
isValid	`readonly`	boolean	Get flag telling whether the analysis is valid.
kilometersDriven	`readonly`	number	Get the driven kilometers. Part of session statistics.
minutesDriven	`readonly`	number	Get the number of minutes driven. Part of session statistics.
minutesSpeeding	`readonly`	number	Returns the total number of minutes the driver was speeding. Part of session statistics.
minutesTailgating	`readonly`	number	Returns the total number of minutes the driver was tailgating. Part of session statistics.
minutesTotalElapsed	`readonly`	number	Get the total number of elapsed minutes. Part of session statistics.
numberOfCorneringEvents	`readonly`	number	Number of cornering events detected
numberOfEncounteredStopSigns	`readonly`	number	Number of stop signs detected
numberOfHarshAccelerationEvents	`readonly`	number	Number of harsh acceleration events detected
numberOfHarshBrakingEvents	`readonly`	number	Number of harsh breaking events detected
numberOfIgnoredStopSigns	`readonly`	number	Number of ignored stop signs events detected
numberOfSwervingEvents	`readonly`	number	Number of swerving events detected
pointerId	`readonly`	number \| bigint
riskRelatedToMeanSpeed	`readonly`	number	Increase of accident probability over a nominal chance (percentage).
riskRelatedToSpeedVariation	`readonly`	number	Increase of accident probability over a nominal chance (percentage).
startTime	`readonly`	number	Get the start time of the session in milliseconds since epoch.

Methods

Method	Modifiers	Description
dispose()
init(id)	`static`