Source: thermodynamicDiagram/DiagramParcel.js

  1. /**
  2.  * @module meteoJS/thermodynamicDiagram/diagramParcel
  3.  */
  4. import addEventFunctions from '../Events.js';
  5. import Unique from '../base/Unique.js';
  6. import {
  7.   getNormalizedLineOptions,
  8.   updateLineOptions
  9. } from '../thermodynamicDiagram/Functions.js';
  11. /**
  12.  * Change visibility event. Only triggered, if the visibility of the parcel
  13.  * changes.
  14.  * 
  15.  * @event module:meteoJS/thermodynamicDiagram/diagramParcel#change:visible
  16.  */
  18. /**
  19.  * Change options event.
  20.  * 
  21.  * @event module:meteoJS/thermodynamicDiagram/diagramParcel#change:options
  22.  */
  24. /**
  25.  * Style/visibility options for a parcel in the thermodynamic diagram.
  26.  * 
  27.  * @typedef {Object}
  28.  *   module:meteoJS/thermodynamicDiagram/diagramParcel~parcelOptions
  29.  * @property {boolean} [visible=true]
  30.  *   Visibility in the thermodynamic diagram.
  31.  * @property {module:meteoJS/thermodynamicDiagram~lineOptions}
  32.  *   [temp] - Options for the temperature curve.
  33.  * @property {module:meteoJS/thermodynamicDiagram~lineOptions}
  34.  *   [dewp] - Options for the dewpoint curve.
  35.  */
  37. /**
  38.  * Definition of the options for the constructor.
  39.  * 
  40.  * @typedef {module:meteoJS/base/unique~options}
  41.  *   module:meteoJS/thermodynamicDiagram/diagramParcel~options
  42.  * @property {module:meteoJS/sounding/parcel.Parcel} [parcel] - Parcel object.
  43.  * @property {boolean} [visible=true] - Visibility of the parcel.
  44.  * @property {module:meteoJS/thermodynamicDiagram~lineOptions}
  45.  *   [temp] - Options for the temperature curve.
  46.  * @property {module:meteoJS/thermodynamicDiagram~lineOptions}
  47.  *   [dewp] - Options for the dewpoint curve.
  48.  */
  50. /**
  51.  * Representation of a plotted parcel (data and display options)
  52.  * 
  53.  * <pre><code>import DiagramParcel from 'meteojs/thermodynamicDiagram/DiagramParcel';</code></pre>
  54.  * 
  55.  * @extends module:meteoJS/base/unique.Unique
  56.  * @fires module:meteoJS/thermodynamicDiagram/diagramParcel#change:visible
  57.  * @fires module:meteoJS/thermodynamicDiagram/diagramParcel#change:options
  58.  */
  59. export class DiagramParcel extends Unique {
  60.   
  61.   /**
  62.    * @param {module:meteoJS/thermodynamicDiagram/diagramParcel~options} [options] - Options.
  63.    */
  64.   constructor({
  65.     parcel = undefined,
  66.     visible = true,
  67.     temp = {},
  68.     dewp = {},
  69.     ...rest
  70.   } = {}) {
  71.     super(rest);
  72.     
  73.     /**
  74.      * @type module:meteoJS/sounding/parcel.Parcel
  75.      * @private
  76.      */
  77.     this._parcel = parcel;
  78.     if (this.id === undefined && parcel !== undefined)
  79.       this.id = parcel.id;
  80.     
  81.     /**
  82.      * @type {module:meteoJS/thermodynamicDiagram/diagramParcel~parcelOptions}
  83.      * @private
  84.      */
  85.     this._options = {
  86.       visible,
  87.       temp: getNormalizedLineOptions(temp, {
  88.         style: {
  89.           color: 'rgb(255, 153, 0)',
  90.           width: 3,
  91.           linecap: 'round'
  92.         }
  93.       }),
  94.       dewp: getNormalizedLineOptions(dewp, {
  95.         style: {
  96.           color: 'rgb(255, 153, 0)',
  97.           width: 3,
  98.           linecap: 'round'
  99.         }
  100.       })
  101.     };
  102.   }
  104.   /**
  105.    * Parcel object.
  106.    * 
  107.    * @type module:meteoJS/sounding/parcel.Parcel
  108.    * @readonly
  109.    */
  110.   get parcel() {
  111.     return this._parcel;
  112.   }
  113.   
  114.   /**
  115.    * Visibility of the parcel.
  116.    * 
  117.    * @type {boolean}
  118.    * @fires module:meteoJS/thermodynamicDiagram/diagramParcel#change:visible
  119.    */
  120.   get visible() {
  121.     return this._options.visible;
  122.   }
  123.   set visible(visible) {
  124.     let oldVisible = this._options.visible;
  125.     this._options.visible = visible ? true : false;
  126.     if (oldVisible != this._options.visible)
  127.       this.trigger('change:visible');
  128.   }
  129.   
  130.   /**
  131.    * Style options for the parcel.
  132.    * 
  133.    * @type {module:meteoJS/thermodynamicDiagram/diagramParcel~parcelOptions}
  134.    * @readonly
  135.    */
  136.   get options() {
  137.     return this._options;
  138.   }
  139.   
  140.   /**
  141.    * Updates the style options for the parcel.
  142.    * 
  143.    * @param {module:meteoJS/thermodynamicDiagram/diagramParcel~parcelOptions}
  144.    *   [options] - Options.
  145.    * @fires module:meteoJS/thermodynamicDiagram/diagramParcel#change:visible
  146.    * @fires module:meteoJS/thermodynamicDiagram/diagramParcel#change:options
  147.    */
  148.   update({
  149.     visible = undefined,
  150.     temp = undefined,
  151.     dewp = undefined
  152.   } = {}) {
  153.     let willTrigger = false;
  154.     if (temp === undefined)
  155.       temp = {};
  156.     else
  157.       willTrigger = true;
  158.     if (dewp === undefined)
  159.       dewp = {};
  160.     else
  161.       willTrigger = true;
  162.     
  163.     
  164.     this._options.temp = updateLineOptions(this._options.temp, temp);
  165.     this._options.dewp = updateLineOptions(this._options.dewp, dewp);
  166.     
  167.     if (willTrigger)
  168.       this.trigger('change:options');
  169.     
  170.     if (visible !== undefined)
  171.       this.visible = visible;
  172.   }
  173. }
  174. addEventFunctions(DiagramParcel.prototype);
  175. export default DiagramParcel;