Interface Chart

Indexable

• [k: string]: {
      bounds?: Position[];
      chartFormat?:
          | "other"
          | "gif"
          | "geotiff"
          | "kap"
          | "png"
          | "jpg"
          | "kml"
          | "wkt"
          | "topojson"
          | "geojson"
          | "gpx"
          | "tms"
          | "wms"
          | "S-57"
          | "S-63"
          | "svg";
      chartLayers?: string[];
      chartUrl?: string;
      description?: string;
      geohash?: string;
      identifier?: string;
      name?: string;
      region?: string;
      scale?: number;
      source?: Source;
      tilemapUrl?: string;
      timestamp?: string;
      [k: string]: unknown;
  }

  A chart

  This interface was referenced by Chart's JSON-Schema definition via the patternProperty "(^[A-Za-z0-9_-]{8,}$)".

  • [k: string]: unknown

  • Optionalbounds?: Position[]

    The bounds of the chart. An array containing the position of the upper left corner, and the lower right corner. Useful when the chart isn't inherently geo-referenced.

  • OptionalchartFormat?:
        | "other"
        | "gif"
        | "geotiff"
        | "kap"
        | "png"
        | "jpg"
        | "kml"
        | "wkt"
        | "topojson"
        | "geojson"
        | "gpx"
        | "tms"
        | "wms"
        | "S-57"
        | "S-63"
        | "svg"

    The format of the chart

  • OptionalchartLayers?: string[]

    If the chart format is WMS, the layers enabled for the chart.

  • OptionalchartUrl?: string

    A url to the chart file's storage location

  • Optionaldescription?: string

    A description of the chart

  • Optionalgeohash?: string

    Position related to chart. Alternative to region

  • Optionalidentifier?: string

    Chart number

  • Optionalname?: string

    Chart common name

  • Optionalregion?: string

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

  • Optionalscale?: number

    The scale of the chart, the larger number from 1:200000

  • Optionalsource?: Source

  • OptionaltilemapUrl?: string

    A url to the tilemap of the chart for use in TMS chartplotting apps

  • Optionaltimestamp?: string

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