Class Route

Hierarchy

StatsClassAbstract
- Route

Implements

RouteInterface

Constructors

constructor

new Route(
    creator?: CreatorInterface,
    options?: RouteParsingOptions,
    name?: string | null,
    activityType?: ActivityTypes | null,
    points?: RoutePointInterface[],
    metadata?: RouteMetadataInterface,
): Route
Parameters
- creator: CreatorInterface = ...
- options: RouteParsingOptions = RouteParsingOptions.DEFAULT
- name: string | null = null
- activityType: ActivityTypes | null = null
- points: RoutePointInterface[] = []
- metadata: RouteMetadataInterface = {}
Returns Route
Overrides StatsClassAbstract.constructor
- Defined in src/routes/route.ts:32

Properties

activityType

activityType: ActivityTypes | null

comment

comment: string | null

creator

creator: CreatorInterface

description

description: string | null

`Optional`extensions

extensions?: unknown

links

links: RouteLinkInterface[]

name

name: string | null

number

number: number | null

parseOptions

parseOptions: RouteParsingOptions

stats

stats: Map<string, DataInterface<DefaultDataValue>> = ...

Methods

addDataToStream

addDataToStream(type: string, index: number, value: number): this
Parameters
- type: string
- index: number
- value: number
Returns this
Implementation of RouteInterface.addDataToStream
- Defined in src/routes/route.ts:57

addStat

addStat(stat: DataInterface<unknown>): void
Parameters
- stat: DataInterface<unknown>
Returns void
Implementation of RouteInterface.addStat
Inherited from StatsClassAbstract.addStat
- Defined in src/stats/stats.class.abstract.ts:37

addStream

addStream(stream: RouteStreamInterface): this
Parameters
- stream: RouteStreamInterface
Returns this
Implementation of RouteInterface.addStream
- Defined in src/routes/route.ts:62

addStreams

addStreams(streams: RouteStreamInterface[]): this
Parameters
- streams: RouteStreamInterface[]
Returns this
Implementation of RouteInterface.addStreams
- Defined in src/routes/route.ts:70

clearStats

clearStats(): void
Returns void
Implementation of RouteInterface.clearStats
Inherited from StatsClassAbstract.clearStats
- Defined in src/stats/stats.class.abstract.ts:29

clearStreams

clearStreams(): this
Returns this
Implementation of RouteInterface.clearStreams
- Defined in src/routes/route.ts:82

createStream

createStream(type: string, length?: number): RouteStreamInterface
Parameters
- type: string
- length: number = ...
Returns RouteStreamInterface
Implementation of RouteInterface.createStream
- Defined in src/routes/route.ts:53

getAllExportableStreams

getAllExportableStreams(): RouteStreamInterface[]
Returns RouteStreamInterface[]
Implementation of RouteInterface.getAllExportableStreams
- Defined in src/routes/route.ts:103

getAllStreams

getAllStreams(): RouteStreamInterface[]
Returns RouteStreamInterface[]
Implementation of RouteInterface.getAllStreams
- Defined in src/routes/route.ts:99

getDistance

getDistance(): DataDistance
Returns DataDistance
Implementation of RouteInterface.getDistance
Inherited from StatsClassAbstract.getDistance
- Defined in src/stats/stats.class.abstract.ts:9

getID

getID(): string | null
Returns string | null
Implementation of RouteInterface.getID
Inherited from StatsClassAbstract.getID
- Defined in src/id/id.abstract.class.ts:6

getPointCount

getPointCount(): number
Returns number
Implementation of RouteInterface.getPointCount
- Defined in src/routes/route.ts:204

getPointData

getPointData(): RoutePointInterface[]
Returns RoutePointInterface[]
Implementation of RouteInterface.getPointData
- Defined in src/routes/route.ts:166

getPositionData

getPositionData(): (DataPositionInterface | null)[]
Returns (DataPositionInterface | null)[]
Implementation of RouteInterface.getPositionData
- Defined in src/routes/route.ts:137

getSquashedPositionData

getSquashedPositionData(): DataPositionInterface[]
Returns DataPositionInterface[]
Implementation of RouteInterface.getSquashedPositionData
- Defined in src/routes/route.ts:162

getSquashedStreamData

getSquashedStreamData(streamType: string): number[]
Parameters
- streamType: string
Returns number[]
Implementation of RouteInterface.getSquashedStreamData
- Defined in src/routes/route.ts:129

getStat

getStat<TValue = DefaultDataValue>(
statType: string,
): void | DataInterface<TValue>
Type Parameters
- TValue = DefaultDataValue
Parameters
- statType: string
Returns void | DataInterface<TValue>
Implementation of RouteInterface.getStat
Inherited from StatsClassAbstract.getStat
- Defined in src/stats/stats.class.abstract.ts:13

getStats

getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>
Type Parameters
- TValue = DefaultDataValue
Returns Map<string, DataInterface<TValue>>
Implementation of RouteInterface.getStats
Inherited from StatsClassAbstract.getStats
- Defined in src/stats/stats.class.abstract.ts:17

getStatsAsArray

getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[]
Type Parameters
- TValue = DefaultDataValue
Returns DataInterface<TValue>[]
Implementation of RouteInterface.getStatsAsArray
Inherited from StatsClassAbstract.getStatsAsArray
- Defined in src/stats/stats.class.abstract.ts:21

getStream

getStream(streamType: string): RouteStreamInterface
Parameters
- streamType: string
Returns RouteStreamInterface
Implementation of RouteInterface.getStream
- Defined in src/routes/route.ts:107

getStreamData

getStreamData(streamType: string | RouteStreamInterface): (number | null)[]
Parameters
- streamType: string | RouteStreamInterface
Returns (number | null)[]
Implementation of RouteInterface.getStreamData
- Defined in src/routes/route.ts:124

hasPositionData

hasPositionData(): boolean
Returns boolean
Implementation of RouteInterface.hasPositionData
- Defined in src/routes/route.ts:133

hasStreamData

hasStreamData(streamType: string | RouteStreamInterface): boolean
Parameters
- streamType: string | RouteStreamInterface
Returns boolean
Implementation of RouteInterface.hasStreamData
- Defined in src/routes/route.ts:115

removeStat

removeStat(statType: string): void
Parameters
- statType: string
Returns void
Implementation of RouteInterface.removeStat
Inherited from StatsClassAbstract.removeStat
- Defined in src/stats/stats.class.abstract.ts:25

removeStream

removeStream(streamType: string | RouteStreamInterface): this
Parameters
- streamType: string | RouteStreamInterface
Returns this
Implementation of RouteInterface.removeStream
- Defined in src/routes/route.ts:87

replaceStreamData

replaceStreamData(streamType: string, data: (number | null)[]): this
Parameters
- streamType: string
- data: (number | null)[]
Returns this
Implementation of RouteInterface.replaceStreamData
- Defined in src/routes/route.ts:93

setDistance

setDistance(distance: DataDistance): void
Parameters
- distance: DataDistance
Returns void
Implementation of RouteInterface.setDistance
Inherited from StatsClassAbstract.setDistance
- Defined in src/stats/stats.class.abstract.ts:33

setID

setID(id: string): Route
Parameters
- id: string
Returns Route
Implementation of RouteInterface.setID
Inherited from StatsClassAbstract.setID
- Defined in src/id/id.abstract.class.ts:10

setPoints

setPoints(points: RoutePointInterface[]): this
Parameters
- points: RoutePointInterface[]
Returns this
Implementation of RouteInterface.setPoints
- Defined in src/routes/route.ts:199

toJSON

toJSON(): RouteJSONInterface
Returns RouteJSONInterface
Implementation of RouteInterface.toJSON
- Defined in src/routes/route.ts:211