This is an object used to create an instance of the Catalogue App itself.

Prerequisites

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

• /js/sdcat/SDCat.js
• /js/SDCat.CoveragePlot.js

Constructor

class SDCat.App(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) - The ID of the div which will contain the coverage plot itself. (Default: sdCat).

containerDivId

(String) - The ID of the div which will contain the app itself. A div with this ID needs to exist within the body of the page. (Default: sdCatContainer).

sidemenu

(Object) - Object containing variables which determine whether to show/hide various elements of the sidemenu controls:

show

(Boolean) - Show the sidemenu itself (default: true).

showRadarList

(Boolean) - Shows the list of radars (default: true)

showRadarHemisphereButtons

(Boolean) - Shows the North/South buttons to pre-select radars by hemisphere (default: true)

showRadarInstituteSelection

(Boolean) - Shows a drop down box to pre-select radars by institute (default: true)

showRadarCountrySelection

(Boolean) - Shows a drop down box to pre-select radars by the country they are located in (default: true)

showFileTypeList

(Boolean) - Shows the list of available file types (default: true)

showDateTypeOpts

(Boolean) - Shows the date type control which allows users to determine the date source of the bars (default: true)

showDatePicker

(Boolean) - Shows the date picker, allowing users to select a custom date range (default: true)

showPreselectedDateRanges

(Boolean) - Shows a selection box populated with preselected date ranges (default: true)

showSelectAllButton

(Boolean) - Shows a button which selects all the radars and file types (default: true)

showGenerateButton

(Boolean) - Shows a button which generates the plot (default: true)

showClearButton

(Boolean) - Shows a button which clears the current selection (default: true)

showResetViewButton

(Boolean) - Shows a button to reset the view of the plot after zooming in (default: true)

selectBoxMaxSize

(Integer) - Sets the maximum size of a selection box. Used for the radar list and the file types list (default: 5)

plotBarArea

(Number) - Sets the proportion of the radar area taken up by the coverage bar. The value must be between 0 and 1. If this value is set to less than 0, the app will set it to 0. If the value is greater than 1, the app will set it to 1. (Default: 0.8).

radarArea

(Number) - Size of the radar area. This is used to calculate the height of the div which will contain the plot. This value is not a pixel value (default: 20)

xAxisArea

(Number) - Size of the x-axis area (i.e. the area below the plot). This is used to calculate the height of the div which will contain the plot. This value is not a pixel value (default: 30)

The height of the plot div is calculated to be (radarArea * number_of_radars) + xAxisArea.

preselected

(Object) - Object containing list of items to preselect within the app upon loading:

radars

(Array) - Array of radar codes to preselect in the app. (default: [])

fileTypes

(Array) - Array of file types to preselect in the app. (default: [])