Interface EventInterface

A parsed activity file. An event can contain one activity or a multi-sport collection of activities, together with event-level summary metrics.

interface EventInterface {
    description?: string;
    endDate: Date;
    isMerge: boolean;
    name: string;
    powerCurve?: DataPowerCurve;
    privacy: Privacy;
    srcFileType: FileType;
    startDate: Date;
    addActivities(activities: ActivityInterface[]): void;
    addActivity(activity: ActivityInterface): void;
    addStat(stat: DataInterface<unknown>): void;
    clearActivities(): void;
    clearStats(): void;
    getActivities(): ActivityInterface[];
    getActivityTypesAsArray(): string[];
    getActivityTypesAsString(): string;
    getDeviceNamesAsString(): string;
    getDistance(): DataDistance;
    getDuration(): DataDuration;
    getFirstActivity(): ActivityInterface;
    getID(): string | null;
    getLastActivity(): ActivityInterface;
    getMovingTime(): DataMovingTime;
    getPause(): DataPause;
    getStat<TValue = DefaultDataValue>(
        statType: string,
    ): void | DataInterface<TValue>;
    getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>;
    getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[];
    getTimer(): DataTimerTime;
    isMultiSport(): boolean;
    removeActivity(activity: ActivityInterface): void;
    removeStat(statType: string): void;
    setDistance(distance: DataDistance): void;
    setDuration(duration: DataDuration): void;
    setID(id: string | null): this;
    setMovingTime(duration: DataMovingTime): void;
    setPause(pause: DataPause): void;
    setTimer(duration: DataTimerTime): void;
    toJSON(): EventJSONInterface;
}

Hierarchy (View Summary)

Properties

`Optional`description

description?: string

endDate

endDate: Date

isMerge

isMerge: boolean

name

name: string

`Optional`powerCurve

powerCurve?: DataPowerCurve

privacy

privacy: Privacy

srcFileType

srcFileType: FileType

startDate

startDate: Date

Methods

addActivities

addActivities(activities: ActivityInterface[]): void
Parameters
- activities: ActivityInterface[]
Returns void
- Defined in src/events/event.interface.ts:30

addActivity

addActivity(activity: ActivityInterface): void
Parameters
- activity: ActivityInterface
Returns void
- Defined in src/events/event.interface.ts:28

addStat

addStat(stat: DataInterface<unknown>): void
Parameters
- stat: DataInterface<unknown>
Returns void
Inherited from StatsClassInterface.addStat
- Defined in src/stats/stats.class.interface.ts:22

clearActivities

clearActivities(): void
Returns void
- Defined in src/events/event.interface.ts:42

clearStats

clearStats(): void
Returns void
Inherited from StatsClassInterface.clearStats
- Defined in src/stats/stats.class.interface.ts:18

getActivities

getActivities(): ActivityInterface[]
Returns ActivityInterface[]
- Defined in src/events/event.interface.ts:34

getActivityTypesAsArray

getActivityTypesAsArray(): string[]
Returns string[]
- Defined in src/events/event.interface.ts:36

getActivityTypesAsString

getActivityTypesAsString(): string
Returns string
- Defined in src/events/event.interface.ts:38

getDeviceNamesAsString

getDeviceNamesAsString(): string
Returns string
- Defined in src/events/event.interface.ts:40

getDistance

getDistance(): DataDistance
Returns DataDistance
Inherited from StatsClassInterface.getDistance
- Defined in src/stats/stats.class.interface.ts:8

getDuration

getDuration(): DataDuration
Returns the duration in seconds (This excludes pauses)

Returns DataDuration
Inherited from DurationClassInterface.getDuration
- Defined in src/duration/duration.class.interface.ts:14

getFirstActivity

getFirstActivity(): ActivityInterface
Returns ActivityInterface
- Defined in src/events/event.interface.ts:44

getID

getID(): string | null
Returns string | null
Inherited from IDClassInterface.getID
- Defined in src/id/id.class.interface.ts:4

getLastActivity

getLastActivity(): ActivityInterface
Returns ActivityInterface
- Defined in src/events/event.interface.ts:46

getMovingTime

getMovingTime(): DataMovingTime
Returns the moving time in seconds (This excludes pauses)

Returns DataMovingTime
Inherited from DurationClassInterface.getMovingTime
- Defined in src/duration/duration.class.interface.ts:26

getPause

getPause(): DataPause
Returns the paused time

Returns DataPause
Inherited from DurationClassInterface.getPause
- Defined in src/duration/duration.class.interface.ts:31

getStat

getStat<TValue = DefaultDataValue>(
statType: string,
): void | DataInterface<TValue>
Type Parameters
- TValue = DefaultDataValue
Parameters
- statType: string
Returns void | DataInterface<TValue>
Inherited from StatsClassInterface.getStat
- Defined in src/stats/stats.class.interface.ts:10

getStats

getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>
Type Parameters
- TValue = DefaultDataValue
Returns Map<string, DataInterface<TValue>>
Inherited from StatsClassInterface.getStats
- Defined in src/stats/stats.class.interface.ts:12

getStatsAsArray

getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[]
Type Parameters
- TValue = DefaultDataValue
Returns DataInterface<TValue>[]
Inherited from StatsClassInterface.getStatsAsArray
- Defined in src/stats/stats.class.interface.ts:14

getTimer

getTimer(): DataTimerTime
Returns the timer in seconds (This excludes pauses)

Returns DataTimerTime
Inherited from DurationClassInterface.getTimer
- Defined in src/duration/duration.class.interface.ts:20

isMultiSport

isMultiSport(): boolean
Returns boolean
- Defined in src/events/event.interface.ts:48

removeActivity

removeActivity(activity: ActivityInterface): void
Parameters
- activity: ActivityInterface
Returns void
- Defined in src/events/event.interface.ts:32

removeStat

removeStat(statType: string): void
Parameters
- statType: string
Returns void
Inherited from StatsClassInterface.removeStat
- Defined in src/stats/stats.class.interface.ts:16

setDistance

setDistance(distance: DataDistance): void
Parameters
- distance: DataDistance
Returns void
Inherited from StatsClassInterface.setDistance
- Defined in src/stats/stats.class.interface.ts:20

setDuration

setDuration(duration: DataDuration): void
Parameters
- duration: DataDuration
Returns void
Inherited from DurationClassInterface.setDuration
- Defined in src/duration/duration.class.interface.ts:33

setID

setID(id: string | null): this
Parameters
- id: string | null
Returns this
Inherited from IDClassInterface.setID
- Defined in src/id/id.class.interface.ts:2

setMovingTime

setMovingTime(duration: DataMovingTime): void
Parameters
- duration: DataMovingTime
Returns void
Inherited from DurationClassInterface.setMovingTime
- Defined in src/duration/duration.class.interface.ts:37

setPause

setPause(pause: DataPause): void
Parameters
- pause: DataPause
Returns void
Inherited from DurationClassInterface.setPause
- Defined in src/duration/duration.class.interface.ts:39

setTimer

setTimer(duration: DataTimerTime): void
Parameters
- duration: DataTimerTime
Returns void
Inherited from DurationClassInterface.setTimer
- Defined in src/duration/duration.class.interface.ts:35

toJSON

toJSON(): EventJSONInterface
Returns EventJSONInterface
Overrides SerializableClassInterface.toJSON
- Defined in src/events/event.interface.ts:50