This is an object used to create an instance of a plot which shows the coverage of available SuperDARN data. This is embedded within the app, but using the constructor, you can add a standalone coverage plot independent of the app. This object is, in effect, a particular implementation of the generic CataloguePlot library, designed to look like the static plots available on the VT website.

Prerequisites

The following function libraries are required in order to use this object:

• /js/sdcat/SDCat.js
• /js/catalogue-plot/CataloguePlot.js

Constructor

class SDCat.CoveragePlot(options)

options

(Object) - List of options. These options set attributes of the object:

sdcat

(Object) - Object containing configuration parameters for the SDCat object. Here, you need to specify the URL to the SDCat API instance you wish to query.

Example:

var options = {
   sdcat: {
      url: "http://localhost:8082/api/v2/"
   },
};

plotId

(String) - ID of the div that will contain the plot. If this is not specified, the plot will be appended to the main body of the page. (Default: null).

radars

(Array) - Array of 3-letter radar codes which belong to the radars that are to be shown on the plot. (Default: empty).

fileTypes

(Array) - Array of file types that are to be shown on the plot. (Default: empty).

coverageType

(String) - The coverage type to use on the plot. This is the source of the date information i.e. File for dates based on the date information in the file name or Date for dates based on the date information in the data file itself.

startDatetime

(String) - ISO formatted date/time string representing the start point of the plot (e.g. 2017-01-01T00:00:00).

endDatetime

(String) - ISO formatted date/time string representing the end point of the plot (e.g. 2017-12-31T23:59:59).