Interface Notes

Indexable

• [k: string]: {
      description?: string;
      geohash?: string;
      mimeType?: string;
      position?: Position;
      region?: string;
      source?: Source;
      timestamp?: string;
      title?: string;
      url?: string;
      [k: string]: unknown;
  }

  A note about a region, named with a UUID. Notes might include navigation or cruising info, images, or anything

  This interface was referenced by Notes's JSON-Schema definition via the patternProperty "^urn:mrn:signalk:uuid:[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$".

  • [k: string]: unknown

  • Optionaldescription?: string

    A textual description of the note

  • Optionalgeohash?: string

    Position related to note. Alternative to region or position

  • OptionalmimeType?: string

    MIME type of the note

  • Optionalposition?: Position

  • Optionalregion?: string

    Region related to note. A pointer to a region UUID. Alternative to position or geohash

  • Optionalsource?: Source

  • Optionaltimestamp?: string

    RFC 3339 (UTC only without local offset) string representing date and time.

  • Optionaltitle?: string

    Note's common name

  • Optionalurl?: string

    Location of the note