Sports Lib API - v17.3.0
    Preparing search index...

    Interface RouteFileInterface

    A collection of planned routes and file-level waypoints imported from or exported to a route format.

    interface RouteFileInterface {
        createdAt: Date | null;
        creator: CreatorInterface;
        name: string;
        srcFileType: string;
        addRoute(route: RouteInterface): this;
        addRoutes(routes: RouteInterface[]): this;
        addStat(stat: DataInterface<unknown>): void;
        addWaypoint(waypoint: RouteWaypointInterface): this;
        addWaypoints(waypoints: RouteWaypointInterface[]): this;
        clearRoutes(): this;
        clearStats(): void;
        getDistance(): DataDistance;
        getFirstRoute(): RouteInterface;
        getID(): string | null;
        getRoutes(): RouteInterface[];
        getStat<TValue = DefaultDataValue>(
            statType: string,
        ): void | DataInterface<TValue>;
        getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>;
        getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[];
        getWaypoints(): RouteWaypointInterface[];
        hasRoutes(): boolean;
        removeStat(statType: string): void;
        setDistance(distance: DataDistance): void;
        setID(id: string | null): this;
        toJSON(): RouteFileJSONInterface;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    createdAt creator name srcFileType

    Methods

    addRoute addRoutes addStat addWaypoint addWaypoints clearRoutes clearStats getDistance getFirstRoute getID getRoutes getStat getStats getStatsAsArray getWaypoints hasRoutes removeStat setDistance setID toJSON

    Properties

    createdAt: Date | null
    creator: CreatorInterface
    name: string
    srcFileType: string

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods