Preparing search index...

    Interface CourseApi

    Course REST API provides the following functions for use by plugins.

    interface CourseApi {
        activateRoute(dest: RouteDestination | null): Promise<void>;
        clearDestination(): Promise<void>;
        getCourse(): Promise<CourseInfo>;
        restartCourse(): Promise<void>;
        setDestination(
            dest:
                | (PointDestination & { arrivalCircle?: number | undefined; })
                | null,
        ): Promise<void>;
    }

    Hierarchy

    Index
    activateRoute clearDestination getCourse restartCourse setDestination

    • Start the current leg of the course at the vessel's position: the vessel position becomes the course's previous point, as the Course REST API's restart does. The destination and any active route are unchanged.

      • returns: Rejected Promise when there is no destination or no vessel position.

      Returns Promise<void>

    • Set course to a specified position / waypoint.

      Parameters

      • dest: (PointDestination & { arrivalCircle?: number | undefined; }) | null

        Object containing destination position information.

      Returns Promise<void>

    On This Page
    Course API