Source: thermodynamicDiagram/DiagramSounding.js

  1. /**
  2.  * @module meteoJS/thermodynamicDiagram/diagramSounding
  3.  */
  4. import addEventFunctions from '../Events.js';
  5. import Unique from '../base/Unique.js';
  6. import Collection from '../base/Collection.js';
  7. import {
  8.   getNormalizedLineOptions,
  9.   updateLineOptions
  10. } from '../thermodynamicDiagram/Functions.js';
  11. import DiagramParcel from './DiagramParcel.js';
  13. /**
  14.  * Change visibility event. Only triggered, if the visibility of the sounding
  15.  * changes, not if only a part's visibility (like hodograph) changes.
  16.  * 
  17.  * @event module:meteoJS/thermodynamicDiagram/diagramSounding#change:visible
  18.  */
  20. /**
  21.  * Change options event.
  22.  * 
  23.  * @event module:meteoJS/thermodynamicDiagram/diagramSounding#change:options
  24.  */
  26. /**
  27.  * Options for a line-segment of a sounding in the hodograph.
  28.  * 
  29.  * @typedef {module:meteoJS/thermodynamicDiagram~lineOptions}
  30.  *   module:meteoJS/thermodynamicDiagram/diagramSounding~hodographSegmentOptions
  31.  * @property {number|undefined}
  32.  *   [minPressure] - Minimum pressure level of the segment. Unit: hPa.
  33.  * @property {number|undefined}
  34.  *   [maxPressure] - Maximum pressure level of the segment. Unit: hPa.
  35.  */
  37. /**
  38.  * Options for a sounding in the hodograph.
  39.  * 
  40.  * @typedef {module:meteoJS/thermodynamicDiagram~lineOptions}
  41.  *   module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions
  42.  * @property {number|undefined}
  43.  *   [minPressure] - Minimum pressure level to plot in the hodograph. Unit: hPa.
  44.  * @property {number|undefined}
  45.  *   [maxPressure] - Maximum pressure level to plot in the hodograph. Unit: hPa.
  46.  * @property {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographSegmentOptions[]}
  47.  *   [segments] - Array of segment definitions.
  48.  */
  50. /**
  51.  * Definition of the options for the constructor.
  52.  * 
  53.  * @typedef {Object} module:meteoJS/thermodynamicDiagram/diagramSounding~options
  54.  * @param {boolean} [visible=true] - Visibility of the sounding.
  55.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  56.  *   [diagram] - Options for the thermodynamic diagram part.
  57.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  58.  *   [windprofile] - Options for the windprofile part.
  59.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions}
  60.  *   [hodograph] - Options for this sounding for the hodograph.
  61.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  62.  *   [parcels] - Options for this sounding for the parcels.
  63.  */
  65. /**
  66.  * Representation of a plotted sounding (data and display options)
  67.  * 
  68.  * <pre><code>import DiagramSounding from 'meteojs/thermodynamicDiagram/DiagramSounding';</code></pre>
  69.  * 
  70.  * @extends module:meteoJS/base/unique.Unique
  71.  * @fires module:meteoJS/thermodynamicDiagram/diagramSounding#change:visible
  72.  * @fires module:meteoJS/thermodynamicDiagram/diagramSounding#change:options
  73.  */
  74. export class DiagramSounding extends Unique {
  75.   
  76.   /**
  77.    * @param {module:meteoJS/sounding.Sounding} sounding - Sounding data.
  78.    * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~options} [options] - Options.
  79.    */
  80.   constructor(sounding, {
  81.     visible = true,
  82.     diagram = {},
  83.     windprofile = {},
  84.     hodograph = {},
  85.     parcels = {}
  86.   } = {}) {
  87.     super();
  88.     
  89.     /**
  90.      * @type module:meteoJS/sounding.Sounding
  91.      * @private
  92.      */
  93.     this._sounding = sounding;
  94.     
  95.     /**
  96.      * @type module:meteoJS/base/collection.Collection
  97.      * @private
  98.      */
  99.     this._diagramParcelCollection = new Collection({
  100.       fireReplace: false,
  101.       fireAddRemoveOnReplace: true,
  102.       emptyObjectMaker: () => new DiagramParcel()
  103.     });
  104.     
  105.     /**
  106.      * @type boolean
  107.      * @private
  108.      */
  109.     this._visible = visible;
  110.     
  111.     /**
  112.      * @type Object
  113.      * @private
  114.      */
  115.     this._options = {
  116.       diagram: getNormalizedDiagramOptions(diagram),
  117.       windprofile:  getNormalizedWindprofileOptions(windprofile),
  118.       hodograph: getNormalizedHodographOptions(hodograph),
  119.       parcels: getNormalizedParcelsOptions(parcels)
  120.     };
  121.     
  122.     // Initialize soundig-object with its parcels.
  123.     if (this._sounding !== undefined) {
  124.       this._sounding.parcelCollection.on('add:item',
  125.         parcel => this.addParcel(parcel));
  126.       this._sounding.parcelCollection.on('remove:item', parcel => {
  127.         for (let diagramParcel of this._diagramParcelCollection)
  128.           if (diagramParcel.parcel === parcel)
  129.             this._diagramParcelCollection.remove(diagramParcel);
  130.       });
  131.       for (let parcel of this._sounding.parcelCollection)
  132.         this.addParcel(parcel);
  133.     }
  134.   }
  135.   
  136.   /**
  137.    * Sounding data.
  138.    * 
  139.    * @type module:meteoJS/sounding.Sounding
  140.    * @readonly
  141.    */
  142.   get sounding() {
  143.     return this._sounding;
  144.   }
  145.   
  146.   /**
  147.    * Visibility of the sounding.
  148.    * 
  149.    * @type {boolean}
  150.    * @fires module:meteoJS/thermodynamicDiagram/diagramSounding#change:visible
  151.    */
  152.   get visible() {
  153.     return this._visible;
  154.   }
  155.   set visible(visible) {
  156.     let oldVisible = this._visible;
  157.     this._visible = visible ? true : false;
  158.     if (oldVisible != this._visible)
  159.       this.trigger('change:visible');
  160.   }
  161.   
  162.   get options() {
  163.     return this._options;
  164.   }
  165.   
  166.   /**
  167.    * Collection of the DiagramParcel objects.
  168.    * 
  169.    * @type module:meteoJS/base/collection.Collection
  170.    * @readonly
  171.    */
  172.   get diagramParcelCollection() {
  173.     return this._diagramParcelCollection;
  174.   }
  175.   
  176.   /**
  177.    * Add a parcel with styles to the sounding.
  178.    * (analogue to {@link module:meteoJS/thermodynamicDiagramPluggable.ThermodynamicDiagramPluggable#addSounding})
  179.    * 
  180.    * @param {module:meteoJS/sounding/parcel.Parcel} parcel - Parcel object.
  181.    * @param {module:meteoJS/thermodynamicDiagram/diagramParcel~parcelOptions}
  182.    *   [options] - Style options.
  183.    * @returns {module:meteoJS/thermodynamicDiagram/diagramParcel.diagramParcel}
  184.    *   Parcel object for the diagram with style options.
  185.    */
  186.   addParcel(parcel, options = undefined) {
  187.     options = (options === undefined) ? this.getParcelOptions(parcel) : options;
  188.     options.parcel = parcel;
  189.     const dp = new DiagramParcel(options);
  190.     this._diagramParcelCollection.append(dp);
  191.     return dp;
  192.   }
  193.   
  194.   /**
  195.    * Updated the style options for this sounding.
  196.    * 
  197.    * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~options}
  198.    *   [options] - Options.
  199.    * @fires module:meteoJS/thermodynamicDiagram/diagramSounding#change:visible
  200.    * @fires module:meteoJS/thermodynamicDiagram/diagramSounding#change:options
  201.    */
  202.   update({
  203.     visible = undefined,
  204.     diagram = undefined,
  205.     windprofile = undefined,
  206.     hodograph = undefined,
  207.     parcels = undefined
  208.   } = {}) {
  209.     let willTrigger = false;
  210.     if (diagram === undefined)
  211.       diagram = {};
  212.     else
  213.       willTrigger = true;
  214.     if (windprofile === undefined)
  215.       windprofile = {};
  216.     else
  217.       willTrigger = true;
  218.     if (hodograph === undefined)
  219.       hodograph = {};
  220.     else
  221.       willTrigger = true;
  222.     
  223.     this._options.diagram =
  224.       updateDiagramOptions(this._options.diagram, diagram);
  225.     this._options.windprofile =
  226.       updateWindprofileOptions(this._options.windprofile, windprofile);
  227.     this._options.hodograph =
  228.       updateHodographOptions(this._options.hodograph, hodograph);
  229.     if (willTrigger)
  230.       this.trigger('change:options');
  231.     
  232.     if (parcels === undefined)
  233.       parcels = {};
  234.     this._options.parcels =
  235.       updateParcelsOptions(this._options.parcels, parcels);
  236.     for (let diagramParcel of this.diagramParcelCollection) {
  237.       if (diagramParcel.id in parcels)
  238.         diagramParcel.update(parcels[diagramParcel.id]);
  239.     }
  240.     
  241.     if (visible !== undefined)
  242.       this.visible = visible;
  243.   }
  244.   
  245.   /**
  246.    * Returns normalized visibility and style options for a parcel. This is a
  247.    * combination of the specific options for the passed parcel and the defaults.
  248.    * 
  249.    * @param {module:meteoJS/sounding/parcel.Parcel} [parcel] - Parcel.
  250.    * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  251.    *   Parcel options.
  252.    * @public
  253.    */
  254.   getParcelOptions(parcel = undefined) {
  255.     let result = {
  256.       visible: this.options.parcels.default.visible,
  257.       temp: {
  258.         visible: this.options.parcels.default.temp.visible,
  259.         style: {}
  260.       },
  261.       dewp: {
  262.         visible: this.options.parcels.default.dewp.visible,
  263.         style: {}
  264.       }
  265.     };
  266.     ['temp', 'dewp'].forEach(key => {
  267.       Object.keys(this.options.parcels.default[key].style).forEach(styleKey => {
  268.         result[key].style[styleKey] =
  269.           this.options.parcels.default[key].style[styleKey];
  270.       });
  271.     });
  272.     if (parcel !== undefined &&
  273.         parcel.id in this.options.parcels)
  274.       result = updateOptionsPart(result, this.options.parcels[parcel.id],
  275.         ['temp', 'dewp']);
  276.     return result;
  277.   }
  278. }
  279. addEventFunctions(DiagramSounding.prototype);
  280. export default DiagramSounding;
  282. /**
  283.  * Style/visibility options for a sounding in the thermodynamic diagram.
  284.  * 
  285.  * @typedef {Object} module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions
  286.  * @param {boolean} [visible=true]
  287.  *   Visibility in the thermodynamic diagram.
  288.  * @param {module:meteoJS/thermodynamicDiagram~lineOptions}
  289.  *   [temp] - Options for the temperature curve.
  290.  * @param {module:meteoJS/thermodynamicDiagram~lineOptions}
  291.  *   [dewp] - Options for the dewpoint curve.
  292.  * @param {module:meteoJS/thermodynamicDiagram~lineOptions}
  293.  *   [wetbulb] - Options for the wetbulb temperature curve.
  294.  */
  296. /**
  297.  * Returns normalized diagram options.
  298.  * 
  299.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  300.  *   [options] - Options.
  301.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  302.  *   Normalized options.
  303.  * @private
  304.  */
  305. function getNormalizedDiagramOptions({
  306.   visible = true,
  307.   temp = {},
  308.   dewp = {},
  309.   wetbulb = {}
  310. } = {}) {
  311.   return {
  312.     visible,
  313.     temp: getNormalizedLineOptions(temp, {
  314.       style: {
  315.         color: 'red',
  316.         width: 3,
  317.         linecap: 'round'
  318.       }
  319.     }),
  320.     dewp: getNormalizedLineOptions(dewp, {
  321.       style: {
  322.         color: 'blue',
  323.         width: 3,
  324.         linecap: 'round'
  325.       }
  326.     }),
  327.     wetbulb: getNormalizedLineOptions(wetbulb, {
  328.       style: {
  329.         color: 'green',
  330.         width: 2,
  331.         linecap: 'round'
  332.       }
  333.     })
  334.   };
  335. }
  337. /**
  338.  * Updates diagram options.
  339.  * 
  340.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  341.  *   options - Current options.
  342.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  343.  *   updateOptions - Some new options.
  344.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  345.  *   New options object.
  346.  * @private
  347.  */
  348. function updateDiagramOptions(options, updateOptions) {
  349.   return updateOptionsPart(options, updateOptions, ['temp', 'dewp', 'wetbulb']);
  350. }
  352. /**
  353.  * Style/visibility options for a sounding in the windprofile.
  354.  * 
  355.  * @typedef {Object} module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions
  356.  * @param {boolean} [visible=true] - Visibility in the windprofile part.
  357.  * @param {module:meteoJS/thermodynamicDiagram~lineOptions}
  358.  *   [windbarbs] - Options for the windbarbs.
  359.  * @param {module:meteoJS/thermodynamicDiagram~lineOptions}
  360.  *   [windspeed] - Options for the windspeed line.
  361.  */
  363. /**
  364.  * Returns normalized windprofile options.
  365.  * 
  366.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  367.  *   [options] - Options.
  368.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  369.  *   Normalized options.
  370.  * @private
  371.  */
  372. function getNormalizedWindprofileOptions({
  373.   visible = true,
  374.   windbarbs = {},
  375.   windspeed = {}
  376. } = {}) {
  377.   return {
  378.     visible,
  379.     windbarbs: getNormalizedLineOptions(windbarbs),
  380.     windspeed: getNormalizedLineOptions(windspeed)
  381.   };
  382. }
  384. /**
  385.  * Updates windprofile options.
  386.  * 
  387.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  388.  *   options - Current options.
  389.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  390.  *   updateOptions - Some new options.
  391.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  392.  *   New options object.
  393.  * @private
  394.  */
  395. function updateWindprofileOptions(options, updateOptions) {
  396.   return updateOptionsPart(options, updateOptions, ['windbarbs', 'windspeed']);
  397. }
  399. /**
  400.  * Returns normalized hodograph options.
  401.  * 
  402.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions}
  403.  *   [options] - Options.
  404.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions}
  405.  *   Normalized options.
  406.  * @private
  407.  */
  408. function getNormalizedHodographOptions({
  409.   minPressure = undefined,
  410.   maxPressure = undefined,
  411.   segments = [],
  412.   ...result
  413. } = {}) {
  414.   result = getNormalizedLineOptions(result, {
  415.     style: {
  416.       color: 'green',
  417.       width: 2
  418.     }
  419.   });
  420.   result.minPressure = minPressure;
  421.   result.maxPressure = maxPressure;
  422.   result.segments = segments.map(({
  423.     minPressure = undefined,
  424.     maxPressure = undefined,
  425.     ...segment
  426.   }) => {
  427.     segment = getNormalizedLineOptions(segment);
  428.     segment.minPressure = minPressure;
  429.     segment.maxPressure = maxPressure;
  430.     return segment;
  431.   });
  432.   return result;
  433. }
  435. /**
  436.  * Updates hodograph options.
  437.  * 
  438.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions}
  439.  *   options - Current options.
  440.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions}
  441.  *   updateOptions - Some new options.
  442.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~hodographOptions}
  443.  *   New options object.
  444.  * @private
  445.  */
  446. function updateHodographOptions(options, updateOptions) {
  447.   options = updateLineOptions(options, updateOptions);
  448.   ['minPressure', 'maxPressure'].forEach(styleKey => {
  449.     if (styleKey in updateOptions)
  450.       options[styleKey] = updateOptions[styleKey];
  451.   });
  452.   if ('segments' in updateOptions)
  453.     options.segments = updateOptions.segments.map(({
  454.       minPressure = undefined,
  455.       maxPressure = undefined,
  456.       ...segment
  457.     }) => {
  458.       segment = getNormalizedLineOptions(segment);
  459.       segment.minPressure = minPressure;
  460.       segment.maxPressure = maxPressure;
  461.       return segment;
  462.     });
  463.   return options;
  464. }
  466. /**
  467.  * Visibility/style of the parcels. This object can contain further keys with
  468.  * values as {@link module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  469.  * which applies to the parcel with the equivalent id.
  470.  * 
  471.  * @typedef {Object} module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions
  472.  * @param {boolean} [visible=true] - Visibility of the parcels.
  473.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions}
  474.  *   [default] - Default options for a parcel.
  475.  */
  477. /**
  478.  * Returns normalized parcels options.
  479.  * 
  480.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  481.  *   [options] - Options.
  482.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  483.  *   Normalized options.
  484.  * @private
  485.  */
  486. function getNormalizedParcelsOptions(options = {}) {
  487.   if (options.visible === undefined)
  488.     options.visible = true;
  489.   if (options.default === undefined)
  490.     options.default = {};
  491.   if (options.default.visible === undefined)
  492.     options.default.visible = false;
  493.   if (options.default.temp === undefined)
  494.     options.default.temp = {};
  495.   if (options.default.temp.visible === undefined)
  496.     options.default.temp.visible = true;
  497.   if (options.default.temp.style === undefined)
  498.     options.default.temp.style = {};
  499.   if (options.default.temp.style.color === undefined)
  500.     options.default.temp.style.color = 'rgb(255, 153, 0)';
  501.   if (options.default.temp.style.width === undefined)
  502.     options.default.temp.style.width = 3;
  503.   if (options.default.temp.style.linecap === undefined)
  504.     options.default.temp.style.linecap = 'round';
  505.   if (options.default.dewp === undefined)
  506.     options.default.dewp = {};
  507.   if (options.default.dewp.visible === undefined)
  508.     options.default.dewp.visible = true;
  509.   if (options.default.dewp.style === undefined)
  510.     options.default.dewp.style = {};
  511.   if (options.default.dewp.style.color === undefined)
  512.     options.default.dewp.style.color = 'rgb(255, 194, 102)';
  513.   if (options.default.dewp.style.width === undefined)
  514.     options.default.dewp.style.width = 3;
  515.   if (options.default.dewp.style.linecap === undefined)
  516.     options.default.dewp.style.linecap = 'round';
  517.   return options;
  518. }
  520. /**
  521.  * Updates Parcels options.
  522.  * 
  523.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  524.  *   options - Current options.
  525.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  526.  *   updateOptions - Some new options.
  527.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~parcelsOptions}
  528.  *   New options object.
  529.  * @private
  530.  */
  531. function updateParcelsOptions(options, updateOptions) {
  532.   if ('visible' in updateOptions)
  533.     options.visible = updateOptions.visible;
  534.   if ('default' in updateOptions)
  535.     options.default =
  536.       updateOptionsPart(options.default, updateOptions.default,
  537.         ['temp', 'dewp']);
  538.   Object.keys(updateOptions)
  539.     .filter(key => key != 'visible' && key != 'default')
  540.     .forEach(key =>
  541.       options[key] =
  542.         updateDiagramOptions(
  543.           (key in options) ? options[key] : {},
  544.           updateOptions[key]));
  545.   return options;
  546. }
  548. /**
  549.  * Updates diagram/windprofile options.
  550.  * 
  551.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions|module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  552.  *   options - Current options.
  553.  * @param {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions|module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  554.  *   updateOptions - Some new options.
  555.  * @param {Array.<string>} [lineKeys] - Keys to update.
  556.  * @returns {module:meteoJS/thermodynamicDiagram/diagramSounding~diagramOptions|module:meteoJS/thermodynamicDiagram/diagramSounding~windprofileOptions}
  557.  *   New options object.
  558.  * @private
  559.  */
  560. function updateOptionsPart(options, updateOptions, lineKeys = []) {
  561.   if ('visible' in updateOptions)
  562.     options.visible = updateOptions.visible;
  563.   lineKeys.forEach(key => {
  564.     if (key in updateOptions)
  565.       options[key] = updateLineOptions(options[key] ? options[key] : { style: {} }, updateOptions[key]);
  566.   });
  567.   return options;
  568. }