ESDoc Home Reference Source Repository

References

Class Summary

Static Public Class Summary
public	App This class builds the whole application and plugs everything together using events.
public	ButtonGroupControl Abstract control.
public	ClusterModeControl A single button that switches its text between 'Hide Clusters' and 'Show Clusters' when clicked.
public	HelpControl A help bar with several buttons which open popup modals when clicked.
public	InfoSignControl A little info icon control which when clicked fires a `click` event.
public	TimePeriodControl A button group control for switching between different time periods, currently Historic, Seasonal Forecasts, and Climate Projections.
public	TimeSeriesPlotC3 Displays a popup with an interactive plot showing the data of a time series coverage (all axes fixed except time).
public	TimeSeriesPlotHighcharts Displays a popup with an interactive plot showing the data of a time series coverage (all axes fixed except time).
public	VariablesControl A button group control for switching between different climate/energy variable dropdowns and selecting a specific variable using radio buttons.

Function Summary

Static Public Function Summary
public	$(selector: string, parent: string \| Element): Array<Element> Returns all child elements of parent (fall-back to document if not given) matching the given selector as an array.
public	$$(selector: string, parent: string \| Element): Element Returns the first child element of parent (fall-back to document if not given) matching the given selector.
public	EventMixin(base: class): class Wraps Leaflet's L.Evented for use within class expressions.
public	HTML(html: string): Array<Element> Turns an HTML string into an array of DOM elements.
public	HTMLone(html: string): Element Turns an HTML string into a DOM element.
public	add(nodes: string \| Node \| Array<Node>, el: Node) Adds the given nodes as children to the given parent node.
public	darken(hex: string, ratio: number): string Darken a given hex color by a given ratio.
public	loadClusterLayer(geojsonPath: string): L.GeoJSON Loads the given GeoJSON URL and returns a Leaflet GeoJSON layer that contains a child layer for each cluster.
public	loadCountryLayer(geojsonPath: string): L.GeoJSON Loads the given GeoJSON URL and returns a Leaflet GeoJSON layer that contains a child layer for each country.

Variable Summary

Static Public Variable Summary
public	HelpControlTemplate: string The template for the HelpControl.
public	IndexTemplate: string The template for the App.
public	TimePeriodControlTemplate: string The template for the TimePeriodControl.
public	VariablesControlTemplate: string The template for the VariablesControl.

Typedef Summary

Static Public Typedef Summary
public	ButtonGroupControl#add: Object The `add` event, signalling that the control has been added to the map.
public	ButtonGroupControl#change: Object The `change` event, signalling that a different button has been pressed.
public	ClusterModeControl#change: Object The `change` event, signalling that the button has been pressed.
public	InfoSignControl#click: Object The `click` event, signalling that the icon has been clicked.
public	VariablesControl#paramchange: Object The `add` event, signalling that the control has been added to the map.

External Summary

Static Public External Summary
public	CovJSON
public	CovUtils
public	HTMLElement
public	Highcharts
public	L
public	L.Control
public	L.Evented
public	L.GeoJSON
public	L.Map
public	L.Marker
public	L.Popup
public	c3