Signal K
    Preparing search index...

    Interface Course

    Course information computed with Rhumbline

    interface Course {
        activeRoute?: {
            estimatedTimeOfArrival?: DatetimeValue;
            href?: string;
            startTime?: DatetimeValue;
            [k: string]: unknown;
        };
        bearingTrackMagnetic?: NumberValue;
        bearingTrackTrue?: NumberValue;
        crossTrackError?: NumberValue;
        nextPoint?: | CommonValueFields
        | {
            bearingMagnetic?: NumberValue;
            bearingTrue?: NumberValue;
            distance?: NumberValue;
            estimatedTimeOfArrival?: DatetimeValue;
            position?: Position;
            timeToGo?: NumberValue;
            value?: { href?: string; type?: string; [k: string]: unknown };
            velocityMadeGood?: NumberValue;
            [k: string]: unknown;
        };
        previousPoint?: CommonValueFields & {
            distance?: NumberValue;
            position?: Position;
            value?: { href?: string; type?: string; [k: string]: unknown };
            [k: string]: unknown;
        };
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    activeRoute? bearingTrackMagnetic? bearingTrackTrue? crossTrackError? nextPoint? previousPoint?

    Properties

    activeRoute?: {
        estimatedTimeOfArrival?: DatetimeValue;
        href?: string;
        startTime?: DatetimeValue;
        [k: string]: unknown;
    }

    Data required if sailing to an active route, defined in resources.

    Type declaration

    • [k: string]: unknown
    • OptionalestimatedTimeOfArrival?: DatetimeValue
    • Optionalhref?: string

      A reference (URL) to the presently active route, in resources.

    • OptionalstartTime?: DatetimeValue
    bearingTrackMagnetic?: NumberValue
    bearingTrackTrue?: NumberValue
    crossTrackError?: NumberValue
    nextPoint?:
        | CommonValueFields
        | {
            bearingMagnetic?: NumberValue;
            bearingTrue?: NumberValue;
            distance?: NumberValue;
            estimatedTimeOfArrival?: DatetimeValue;
            position?: Position;
            timeToGo?: NumberValue;
            value?: { href?: string; type?: string; [k: string]: unknown };
            velocityMadeGood?: NumberValue;
            [k: string]: unknown;
        }

    The point on earth the vessel's presently navigating towards

    previousPoint?: CommonValueFields & {
        distance?: NumberValue;
        position?: Position;
        value?: { href?: string; type?: string; [k: string]: unknown };
        [k: string]: unknown;
    }

    The point on earth the vessel's presently navigating from

    On This Page

    Properties