autumnplot-gl
Classes
| Class | Description |
|---|---|
| Barbs | A class representing a field of wind barbs. The barbs are automatically thinned based on the zoom level on the map; the user only has to provide a thinning factor at zoom level 1. |
| Color | A class for handling colors and translations between different color spaces |
| ColorMap | A mapping from values to colors |
| Contour | A field of contoured data. |
| ContourFill | A filled contoured field |
| ContourLabels | Label the contours on a plot |
| Grid | The base class for grid types |
| Hodographs | A class representing a field of hodograph plots |
| LambertGrid | A Lambert conformal conic grid with uniform grid spacing |
| MultiPlotLayer | A varying map layer. If the data don't have a varying component, such as over time, it might be easier to use a PlotLayer instead. |
| Paintball | A class representing a paintball plot, which is a plot of objects in every member of an ensemble. Objects are usually defined by a single threshold on a field (such as simulated reflectivity greater than 40 dBZ), but could in theory be defined by any arbitrarily complicated method. In autumnplot-gl, the data for the paintball plot is given as a single field with the objects from each member encoded as "bits" in the field. Because the field is made up of single-precision floats, this works for up to 24 members. (Technically speaking, I don't need the quotes around "bits", as they're bits of the significand of an IEEE 754 float.) |
| PlateCarreeGrid | A plate carree (a.k.a. lat/lon) grid with uniform grid spacing |
| PlateCarreeRotatedGrid | A rotated lat-lon (plate carree) grid with uniform grid spacing |
| PlotComponent | Base class for all plot components |
| PlotLayer | A static map layer. The data are assumed to be static in time. If the data have a time component (e.g., a model forecast), a MultiPlotLayer may be more appropriate. |
| Raster | A raster (i.e. pixel) plot |
| RawObsField | Raw observation data, given as a list of objects |
| RawProfileField | A class grid of wind profiles |
| RawScalarField | A class representing a raw 2D field of gridded data, such as height or u wind. |
| RawVectorField | A class representing a 2D gridded field of vectors |
| StationPlot | Station model plots for observed data |
| StructuredGrid | A structured grid (in this case meaning a cartesian grid with i and j coordinates) |
| UnstructuredGrid | An unstructured grid defined by a list of latitudes and longitudes |
Interfaces
| Interface | Description |
|---|---|
| BarbsOptions | Options for Barbs components |
| ColorBarOptions | Options for ColorBars |
| ColorMapOptions | Options for ColorMaps |
| ContourFillOptions | Options for ContourFill components |
| ContourLabelOptions | Options for ContourLabels |
| ContourOptions | Options for Contour components |
| FieldContourOpts | Options for contouring data via RawScalarField.getContours() |
| GroundRelativeWindProfile | A wind profile without a storm motion for plotting ground-relative hodographs |
| HodographOptions | Options for Hodographs components |
| InitAutumnPlotOpts | Options for initializing the autumnplot-gl library |
| PaintballKeyOptions | Options for makePaintballKey() |
| PaintballOptions | Options for Paintball components |
| RasterOptions | Options for Raster components |
| RawVectorFieldOptions | Options for RawVectorFields |
| SPBarbConfig | Configuration for wind barbs on station plots |
| SPNumberConfig | Configuration for numerical values on station plots |
| SPStringConfig | Configuration for strings on station plots |
| SPSymbolConfig | Configuration for symbols on station plots |
| StationPlotOptions | Options for StationPlot components |
| StormRelativeWindProfile | A wind profile with a storm-motion for plotting storm-relative hodographs |
Type Aliases
| Type Alias | Description |
|---|---|
| ColorbarOrientation | The orientation for color bars (horizontal or vertical) |
| ColorbarTickDirection | Which side of a color bar the ticks are on |
| ContourData | The result of contouring a field |
| GridType | - |
| LineStyle | A style to use to draw lines. The possible options are '-' for a solid line, '--' for a dashed line, ':' for a dotted line, '-.' for a dash-dot line, or you could pass a list of numbers (e.g., [1, 1, 1, 0, 1, 0]) to specify a custom dash scheme. |
| MapLikeType | Type with the required methods for mapping libraries |
| ObsRawData | Type for an observation data point |
| SPConfig | Configuration for station plot sub-elements |
| SPDataConfig | Configuration for station data plots |
| SPPosition | Positions around the station plot at which to draw the various elements |
| SPSymbol | Accepted symbol codes for sky cover and present weather symbols |
| TypedArray | Javascript typed arrays for use in raw fields |
| VectorRelativeTo | The basis vectors for vector fields (i.e, whether vectors a relative to Earth or the grid) |
| WebGLAnyRenderingContext | WebGL rendering contexts (either WebGL1 or WebGL2) |
| WindProfile | Different types of wind profiles for Hodographs components |
Variables
| Variable | Description |
|---|---|
| colormaps | All built-in colormaps |
Functions
| Function | Description |
|---|---|
| initAutumnPlot | Initialize the WebAssembly module in autumnplot-gl. It's not strictly necessary to call it first, but if you call it first, you can prevent races when you contour a bunch of fields at once. |
| makeColorBar | Make an SVG containing a color bar. The color bar can either be oriented horizontal or vertical, and a label can be provided. |
| makePaintballKey | Make an SVG containing a color key for a paintball plot. The key can be split over any number of columns. |