highcharts 9.2.2 → 9.3.0

package/es-modules/Extensions/Sonification/Earcon.js

@@ -10,9 +10,143 @@
  *
  * */
 'use strict';
-import H from '../../Core/Globals.js';
+import Instrument from './Instrument.js';
 import U from '../../Core/Utilities.js';
 var error = U.error, merge = U.merge, pick = U.pick, uniqueKey = U.uniqueKey;
+/* *
+ *
+ *  Class
+ *
+ * */
+/* eslint-disable no-invalid-this, valid-jsdoc */
+/**
+ * The Earcon class. Earcon objects represent a certain sound consisting of
+ * one or more instruments playing a predefined sound.
+ *
+ * @sample highcharts/sonification/earcon/
+ *         Using earcons directly
+ *
+ * @requires module:modules/sonification
+ *
+ * @class
+ * @name Highcharts.Earcon
+ *
+ * @param {Highcharts.EarconOptionsObject} options
+ *        Options for the Earcon instance.
+ */
+var Earcon = /** @class */ (function () {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    function Earcon(options) {
+        /* *
+         *
+         *  Properties
+         *
+         * */
+        this.id = void 0;
+        this.instrumentsPlaying = void 0;
+        this.options = void 0;
+        this.init(options || {});
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    Earcon.prototype.init = function (options) {
+        this.options = options;
+        if (!this.options.id) {
+            this.options.id = this.id = uniqueKey();
+        }
+        this.instrumentsPlaying = {};
+    };
+    /**
+     * Play the earcon, optionally overriding init options.
+     *
+     * @sample highcharts/sonification/earcon/
+     *         Using earcons directly
+     *
+     * @function Highcharts.Earcon#sonify
+     *
+     * @param {Highcharts.EarconOptionsObject} options
+     * Override existing options.
+     */
+    Earcon.prototype.sonify = function (options) {
+        var playOptions = merge(this.options, options), 
+        // Find master volume/pan settings
+        masterVolume = pick(playOptions.volume, 1), masterPan = playOptions.pan, earcon = this, playOnEnd = options && options.onEnd, masterOnEnd = earcon.options.onEnd;
+        // Go through the instruments and play them
+        playOptions.instruments.forEach(function (opts) {
+            var instrument = typeof opts.instrument === 'string' ?
+                Instrument.definitions[opts.instrument] : opts.instrument, instrumentOpts = merge(opts.playOptions);
+            var instrOnEnd, instrumentCopy, copyId = '';
+            if (instrument && instrument.play) {
+                if (opts.playOptions) {
+                    instrumentOpts.pan = pick(masterPan, instrumentOpts.pan);
+                    // Handle onEnd
+                    instrOnEnd = instrumentOpts.onEnd;
+                    instrumentOpts.onEnd = function () {
+                        delete earcon.instrumentsPlaying[copyId];
+                        if (instrOnEnd) {
+                            instrOnEnd.apply(this, arguments);
+                        }
+                        if (!Object.keys(earcon.instrumentsPlaying).length) {
+                            if (playOnEnd) {
+                                playOnEnd.apply(this, arguments);
+                            }
+                            if (masterOnEnd) {
+                                masterOnEnd.apply(this, arguments);
+                            }
+                        }
+                    };
+                    // Play the instrument. Use a copy so we can play multiple
+                    // at the same time.
+                    instrumentCopy = instrument.copy();
+                    instrumentCopy.setMasterVolume(masterVolume);
+                    copyId = instrumentCopy.id;
+                    earcon.instrumentsPlaying[copyId] = instrumentCopy;
+                    instrumentCopy.play(instrumentOpts);
+                }
+            }
+            else {
+                error(30);
+            }
+        });
+    };
+    /**
+     * Cancel any current sonification of the Earcon. Calls onEnd functions.
+     *
+     * @function Highcharts.Earcon#cancelSonify
+     *
+     * @param {boolean} [fadeOut=false]
+     *        Whether or not to fade out as we stop. If false, the earcon is
+     *        cancelled synchronously.
+     */
+    Earcon.prototype.cancelSonify = function (fadeOut) {
+        var playing = this.instrumentsPlaying, instrIds = playing && Object.keys(playing);
+        if (instrIds && instrIds.length) {
+            instrIds.forEach(function (instr) {
+                playing[instr].stop(!fadeOut, null, 'cancelled');
+            });
+            this.instrumentsPlaying = {};
+        }
+    };
+    return Earcon;
+}());
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default Earcon;
+/* *
+ *
+ *  API Declarations
+ *
+ * */
 /**
  * Define an Instrument and the options for playing it.
  *
@@ -60,104 +194,4 @@ var error = U.error, merge = U.merge, pick = U.pick, uniqueKey = U.uniqueKey;
 * @name Highcharts.EarconOptionsObject#onEnd
 * @type {Function|undefined}
 */
-/* eslint-disable no-invalid-this, valid-jsdoc */
-/**
- * The Earcon class. Earcon objects represent a certain sound consisting of
- * one or more instruments playing a predefined sound.
- *
- * @sample highcharts/sonification/earcon/
- *         Using earcons directly
- *
- * @requires module:modules/sonification
- *
- * @class
- * @name Highcharts.Earcon
- *
- * @param {Highcharts.EarconOptionsObject} options
- *        Options for the Earcon instance.
- */
-function Earcon(options) {
-    this.init(options || {});
-}
-Earcon.prototype.init = function (options) {
-    this.options = options;
-    if (!this.options.id) {
-        this.options.id = this.id = uniqueKey();
-    }
-    this.instrumentsPlaying = {};
-};
-/**
- * Play the earcon, optionally overriding init options.
- *
- * @sample highcharts/sonification/earcon/
- *         Using earcons directly
- *
- * @function Highcharts.Earcon#sonify
- *
- * @param {Highcharts.EarconOptionsObject} options
- *        Override existing options.
- *
- * @return {void}
- */
-Earcon.prototype.sonify = function (options) {
-    var playOptions = merge(this.options, options);
-    // Find master volume/pan settings
-    var masterVolume = pick(playOptions.volume, 1), masterPan = playOptions.pan, earcon = this, playOnEnd = options && options.onEnd, masterOnEnd = earcon.options.onEnd;
-    // Go through the instruments and play them
-    playOptions.instruments.forEach(function (opts) {
-        var instrument = typeof opts.instrument === 'string' ?
-            H.sonification.instruments[opts.instrument] : opts.instrument, instrumentOpts = merge(opts.playOptions), instrOnEnd, instrumentCopy, copyId = '';
-        if (instrument && instrument.play) {
-            if (opts.playOptions) {
-                instrumentOpts.pan = pick(masterPan, instrumentOpts.pan);
-                // Handle onEnd
-                instrOnEnd = instrumentOpts.onEnd;
-                instrumentOpts.onEnd = function () {
-                    delete earcon.instrumentsPlaying[copyId];
-                    if (instrOnEnd) {
-                        instrOnEnd.apply(this, arguments);
-                    }
-                    if (!Object.keys(earcon.instrumentsPlaying).length) {
-                        if (playOnEnd) {
-                            playOnEnd.apply(this, arguments);
-                        }
-                        if (masterOnEnd) {
-                            masterOnEnd.apply(this, arguments);
-                        }
-                    }
-                };
-                // Play the instrument. Use a copy so we can play multiple at
-                // the same time.
-                instrumentCopy = instrument.copy();
-                instrumentCopy.setMasterVolume(masterVolume);
-                copyId = instrumentCopy.id;
-                earcon.instrumentsPlaying[copyId] = instrumentCopy;
-                instrumentCopy.play(instrumentOpts);
-            }
-        }
-        else {
-            error(30);
-        }
-    });
-};
-/**
- * Cancel any current sonification of the Earcon. Calls onEnd functions.
- *
- * @function Highcharts.Earcon#cancelSonify
- *
- * @param {boolean} [fadeOut=false]
- *        Whether or not to fade out as we stop. If false, the earcon is
- *        cancelled synchronously.
- *
- * @return {void}
- */
-Earcon.prototype.cancelSonify = function (fadeOut) {
-    var playing = this.instrumentsPlaying, instrIds = playing && Object.keys(playing);
-    if (instrIds && instrIds.length) {
-        instrIds.forEach(function (instr) {
-            playing[instr].stop(!fadeOut, null, 'cancelled');
-        });
-        this.instrumentsPlaying = {};
-    }
-};
-export default Earcon;
+(''); // detach doclets above