vis-data 7.1.1 → 7.1.4

package/esnext/umd/vis-data.js

@@ -4,8 +4,8 @@
  *
  * Manage unstructured data using DataSet. Add, update, and remove data, and listen for changes in the data.
  *
- * @version 7.1.1
- * @date    2020-11-15T19:08:22.864Z
+ * @version 7.1.4
+ * @date    2022-03-15T15:23:59.245Z
  *
  * @copyright (c) 2011-2017 Almende B.V, http://almende.com
  * @copyright (c) 2017-2019 visjs contributors, https://github.com/visjs
@@ -28,12 +28,11 @@
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('vis-util/esnext/umd/vis-util.js'), require('uuid')) :
   typeof define === 'function' && define.amd ? define(['exports', 'vis-util/esnext/umd/vis-util.js', 'uuid'], factory) :
   (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.vis = global.vis || {}, global.vis, global.uuidv4));
-}(this, (function (exports, esnext, uuid) {
+})(this, (function (exports, esnext, uuid) {
   /**
    * Create new data pipe.
    *
    * @param from - The source data set or data view.
-   *
    * @remarks
    * Example usage:
    * ```typescript
@@ -60,7 +59,6 @@
    *
    * pipe.start();
    * ```
-   *
    * @returns A factory whose methods can be used to configure the pipe.
    */
   function createNewDataPipeFrom(from) {
@@ -76,6 +74,17 @@
    * @typeParam TP - Target item type's id property name.
    */
   class SimpleDataPipe {
+      _source;
+      _transformers;
+      _target;
+      /**
+       * Bound listeners for use with `DataInterface['on' | 'off']`.
+       */
+      _listeners = {
+          add: this._add.bind(this),
+          remove: this._remove.bind(this),
+          update: this._update.bind(this),
+      };
       /**
        * Create a new data pipe.
        *
@@ -88,14 +97,6 @@
           this._source = _source;
           this._transformers = _transformers;
           this._target = _target;
-          /**
-           * Bound listeners for use with `DataInterface['on' | 'off']`.
-           */
-          this._listeners = {
-              add: this._add.bind(this),
-              remove: this._remove.bind(this),
-              update: this._update.bind(this),
-          };
       }
       /** @inheritDoc */
       all() {
@@ -120,7 +121,6 @@
        * Apply the transformers to the items.
        *
        * @param items - The items to be transformed.
-       *
        * @returns The transformed items.
        */
       _transformItems(items) {
@@ -173,6 +173,12 @@
    * @typeParam TP - Target item type's id property name.
    */
   class DataPipeUnderConstruction {
+      _source;
+      /**
+       * Array transformers used to transform items within the pipe. This is typed
+       * as any for the sake of simplicity.
+       */
+      _transformers = [];
       /**
        * Create a new data pipe factory. This is an internal constructor that
        * should never be called from outside of this file.
@@ -181,18 +187,12 @@
        */
       constructor(_source) {
           this._source = _source;
-          /**
-           * Array transformers used to transform items within the pipe. This is typed
-           * as any for the sake of simplicity.
-           */
-          this._transformers = [];
       }
       /**
        * Filter the items.
        *
        * @param callback - A filtering function that returns true if given item
        * should be piped and false if not.
-       *
        * @returns This factory for further configuration.
        */
       filter(callback) {
@@ -204,10 +204,8 @@
        *
        * @param callback - A mapping function that takes a source item and returns
        * corresponding mapped item.
-       *
        * @typeParam TI - Target item type.
        * @typeParam TP - Target item type's id property name.
-       *
        * @returns This factory for further configuration.
        */
       map(callback) {
@@ -219,10 +217,8 @@
        *
        * @param callback - A mapping function that takes a source item and returns
        * an array of corresponding mapped items.
-       *
        * @typeParam TI - Target item type.
        * @typeParam TP - Target item type's id property name.
-       *
        * @returns This factory for further configuration.
        */
       flatMap(callback) {
@@ -233,7 +229,6 @@
        * Connect this pipe to given data set.
        *
        * @param target - The data set that will receive the items from this pipe.
-       *
        * @returns The pipe connected between given data sets and performing
        * configured transformation on the processed items.
        */
@@ -246,7 +241,6 @@
    * Determine whether a value can be used as an id.
    *
    * @param value - Input value of unknown type.
-   *
    * @returns True if the value is valid id, false otherwise.
    */
   function isId(value) {
@@ -259,15 +253,19 @@
    * @typeParam T - The type of method names to be replaced by queued versions.
    */
   class Queue {
+      /** Delay in milliseconds. If defined the queue will be periodically flushed. */
+      delay;
+      /** Maximum number of entries in the queue before it will be flushed. */
+      max;
+      _queue = [];
+      _timeout = null;
+      _extended = null;
       /**
        * Construct a new Queue.
        *
        * @param options - Queue configuration.
        */
       constructor(options) {
-          this._queue = [];
-          this._timeout = null;
-          this._extended = null;
           // options
           this.delay = null;
           this.max = Infinity;
@@ -293,7 +291,6 @@
        *
        * @param object - The object to be extended.
        * @param options - Additional options.
-       *
        * @returns The created queue.
        */
       static extend(object, options) {
@@ -422,22 +419,12 @@
    * @typeParam IdProp - Name of the property that contains the id.
    */
   class DataSetPart {
-      constructor() {
-          this._subscribers = {
-              "*": [],
-              add: [],
-              remove: [],
-              update: [],
-          };
-          /**
-           * @deprecated Use on instead (PS: DataView.subscribe === DataView.on).
-           */
-          this.subscribe = DataSetPart.prototype.on;
-          /**
-           * @deprecated Use off instead (PS: DataView.unsubscribe === DataView.off).
-           */
-          this.unsubscribe = DataSetPart.prototype.off;
-      }
+      _subscribers = {
+          "*": [],
+          add: [],
+          remove: [],
+          update: [],
+      };
       /**
        * Trigger an event
        *
@@ -457,7 +444,6 @@
        * Subscribe to an event, add an event listener.
        *
        * @remarks Non-function callbacks are ignored.
-       *
        * @param event - Event name.
        * @param callback - Callback method.
        */
@@ -471,13 +457,20 @@
        * Unsubscribe from an event, remove an event listener.
        *
        * @remarks If the same callback was subscribed more than once **all** occurences will be removed.
-       *
        * @param event - Event name.
        * @param callback - Callback method.
        */
       off(event, callback) {
           this._subscribers[event] = this._subscribers[event].filter((subscriber) => subscriber !== callback);
       }
+      /**
+       * @deprecated Use on instead (PS: DataView.subscribe === DataView.on).
+       */
+      subscribe = DataSetPart.prototype.on;
+      /**
+       * @deprecated Use off instead (PS: DataView.unsubscribe === DataView.off).
+       */
+      unsubscribe = DataSetPart.prototype.off;
   }
 
   /**
@@ -487,10 +480,10 @@
    * [[DataStream]] offers an always up to date stream of items from a [[DataSet]] or [[DataView]].
    * That means that the stream is evaluated at the time of iteration, conversion to another data type or when [[cache]] is called, not when the [[DataStream]] was created.
    * Multiple invocations of for example [[toItemArray]] may yield different results (if the data source like for example [[DataSet]] gets modified).
-   *
    * @typeParam Item - The item type this stream is going to work with.
    */
   class DataStream {
+      _pairs;
       /**
        * Create a new data stream.
        *
@@ -536,7 +529,6 @@
        *
        * @remarks
        * The array may contain duplicities.
-       *
        * @returns The array with all ids from this stream.
        */
       toIdArray() {
@@ -547,7 +539,6 @@
        *
        * @remarks
        * The array may contain duplicities.
-       *
        * @returns The array with all items from this stream.
        */
       toItemArray() {
@@ -558,7 +549,6 @@
        *
        * @remarks
        * The array may contain duplicities.
-       *
        * @returns The array with all entries from this stream.
        */
       toEntryArray() {
@@ -569,7 +559,6 @@
        *
        * @remarks
        * In case of duplicate ids (coerced to string so `7 == '7'`) the last encoutered appears in the returned object.
-       *
        * @returns The object map of all id → item pairs from this stream.
        */
       toObjectMap() {
@@ -623,7 +612,6 @@
        * ds.clear()
        * chachedStream // Still has all the items.
        * ```
-       *
        * @returns A new [[DataStream]] with cached items (detached from the original [[DataSet]]).
        */
       cache() {
@@ -633,9 +621,7 @@
        * Get the distinct values of given property.
        *
        * @param callback - The function that picks and possibly converts the property.
-       *
        * @typeParam T - The type of the distinct value.
-       *
        * @returns A set of all distinct properties.
        */
       distinct(callback) {
@@ -649,7 +635,6 @@
        * Filter the items of the stream.
        *
        * @param callback - The function that decides whether an item will be included.
-       *
        * @returns A new data stream with the filtered items.
        */
       filter(callback) {
@@ -678,9 +663,7 @@
        * Map the items into a different type.
        *
        * @param callback - The function that does the conversion.
-       *
        * @typeParam Mapped - The type of the item after mapping.
-       *
        * @returns A new data stream with the mapped items.
        */
       map(callback) {
@@ -697,7 +680,6 @@
        * Get the item with the maximum value of given property.
        *
        * @param callback - The function that picks and possibly converts the property.
-       *
        * @returns The item with the maximum if found otherwise null.
        */
       max(callback) {
@@ -722,7 +704,6 @@
        * Get the item with the minimum value of given property.
        *
        * @param callback - The function that picks and possibly converts the property.
-       *
        * @returns The item with the minimum if found otherwise null.
        */
       min(callback) {
@@ -748,9 +729,7 @@
        *
        * @param callback - The function that does the reduction.
        * @param accumulator - The initial value of the accumulator.
-       *
        * @typeParam T - The type of the accumulated value.
-       *
        * @returns The reduced value.
        */
       reduce(callback, accumulator) {
@@ -763,7 +742,6 @@
        * Sort the items.
        *
        * @param callback - Item comparator.
-       *
        * @returns A new stream with sorted items.
        */
       sort(callback) {
@@ -779,13 +757,10 @@
    *
    * @remarks
    * The item will be modified.
-   *
    * @param item - The item that will have an id after a call to this function.
    * @param idProp - The key of the id property.
-   *
    * @typeParam Item - Item type that may or may not have an id.
    * @typeParam IdProp - Name of the property that contains the id.
-   *
    * @returns true
    */
   function ensureFullItem(item, idProp) {
@@ -855,6 +830,18 @@
    * @typeParam IdProp - Name of the property that contains the id.
    */
   class DataSet extends DataSetPart {
+      /** Flush all queued calls. */
+      flush;
+      /** @inheritDoc */
+      length;
+      /** @inheritDoc */
+      get idProp() {
+          return this._idProp;
+      }
+      _options;
+      _data;
+      _idProp;
+      _queue = null;
       /**
        * Construct a new DataSet.
        *
@@ -863,7 +850,6 @@
        */
       constructor(data, options) {
           super();
-          this._queue = null;
           // correctly read optional arguments
           if (data && !Array.isArray(data)) {
               options = data;
@@ -879,10 +865,6 @@
           }
           this.setOptions(options);
       }
-      /** @inheritDoc */
-      get idProp() {
-          return this._idProp;
-      }
       /**
        * Set new options.
        *
@@ -933,9 +915,7 @@
        *
        * @param data - Items to be added (ids will be generated if missing).
        * @param senderId - Sender id.
-       *
        * @returns addedIds - Array with the ids (generated if not present) of the added items.
-       *
        * @throws When an item with the same id as any of the added items already exists.
        */
       add(data, senderId) {
@@ -994,12 +974,9 @@
        *
        * ## Warning for TypeScript users
        * This method may introduce partial items into the data set. Use add or updateOnly instead for better type safety.
-       *
        * @param data - Items to be updated (if the id is already present) or added (if the id is missing).
        * @param senderId - Sender id.
-       *
        * @returns updatedIds - The ids of the added (these may be newly generated if there was no id in the item from the data) or updated items.
-       *
        * @throws When the supplied data is neither an item nor an array of items.
        */
       update(data, senderId) {
@@ -1088,12 +1065,9 @@
        *
        * console.log(ids) // [2]
        * ```
-       *
        * @param data - Updates (the id and optionally other props) to the items in this data set.
        * @param senderId - Sender id.
-       *
        * @returns updatedIds - The ids of the updated items.
-       *
        * @throws When the supplied data is neither an item nor an array of items, when the ids are missing.
        */
       updateOnly(data, senderId) {
@@ -1108,7 +1082,7 @@
               }
               return { oldData, update };
           })
-              .map(({ oldData, update }) => {
+              .map(({ oldData, update, }) => {
               const id = oldData[this._idProp];
               const updatedData = esnext.pureDeepObjectAssign(oldData, update);
               this._data.set(id, updatedData);
@@ -1361,9 +1335,7 @@
        *
        * @param item - The item whose fields should be filtered.
        * @param fields - The names of the fields that will be kept.
-       *
        * @typeParam K - Field name type.
-       *
        * @returns The item without any additional fields.
        */
       _filterFields(item, fields) {
@@ -1385,7 +1357,6 @@
        *
        * @param items - Items to be sorted in place.
        * @param order - A field name or custom sort function.
-       *
        * @typeParam T - The type of the items in the items array.
        */
       _sort(items, order) {
@@ -1433,7 +1404,6 @@
        *
        * @param id - One or more items or ids of items to be removed.
        * @param senderId - Sender id.
-       *
        * @returns The ids of the removed items.
        */
       remove(id, senderId) {
@@ -1460,7 +1430,6 @@
        * Remove an item by its id or reference.
        *
        * @param id - Id of an item or the item itself.
-       *
        * @returns The removed item if removed, null otherwise.
        */
       _remove(id) {
@@ -1489,7 +1458,6 @@
        * After the items are removed, the [[DataSet]] will trigger an event `remove` for all removed items. When a `senderId` is provided, this id will be passed with the triggered event to all subscribers.
        *
        * @param senderId - Sender id.
-       *
        * @returns removedIds - The ids of all removed items.
        */
       clear(senderId) {
@@ -1507,7 +1475,6 @@
        * Find the item with maximum value of a specified field.
        *
        * @param field - Name of the property that should be searched for max value.
-       *
        * @returns Item containing max value, or null if no items.
        */
       max(field) {
@@ -1527,7 +1494,6 @@
        * Find the item with minimum value of a specified field.
        *
        * @param field - Name of the property that should be searched for min value.
-       *
        * @returns Item containing min value, or null if no items.
        */
       min(field) {
@@ -1547,7 +1513,6 @@
        * Find all distinct values of a specified field
        *
        * @param prop - The property name whose distinct values should be returned.
-       *
        * @returns Unordered array containing all distinct values. Items without specified property are ignored.
        */
       distinct(prop) {
@@ -1577,7 +1542,6 @@
        * Add a single item. Will fail when an item with the same id already exists.
        *
        * @param item - A new item to be added.
-       *
        * @returns Added item's id. An id is generated when it is not present in the item.
        */
       _addItem(item) {
@@ -1597,7 +1561,6 @@
        * Will fail when the item has no id, or when there does not exist an item with the same id.
        *
        * @param update - The new item
-       *
        * @returns The id of the updated item.
        */
       _updateItem(update) {
@@ -1684,6 +1647,16 @@
    * @typeParam IdProp - Name of the property that contains the id.
    */
   class DataView extends DataSetPart {
+      /** @inheritDoc */
+      length = 0;
+      /** @inheritDoc */
+      get idProp() {
+          return this.getDataSet().idProp;
+      }
+      _listener;
+      _data; // constructor → setData
+      _ids = new Set(); // ids of the items currently in memory (just contains a boolean true)
+      _options;
       /**
        * Create a DataView.
        *
@@ -1692,24 +1665,16 @@
        */
       constructor(data, options) {
           super();
-          /** @inheritDoc */
-          this.length = 0;
-          this._ids = new Set(); // ids of the items currently in memory (just contains a boolean true)
           this._options = options || {};
           this._listener = this._onEvent.bind(this);
           this.setData(data);
       }
-      /** @inheritDoc */
-      get idProp() {
-          return this.getDataSet().idProp;
-      }
       // TODO: implement a function .config() to dynamically update things like configured filter
       // and trigger changes accordingly
       /**
        * Set a data source for the view.
        *
        * @param data - The instance containing data (directly or indirectly).
-       *
        * @remarks
        * Note that when the data view is bound to a data set it won't be garbage
        * collected unless the data set is too. Use `dataView.setData(null)` or
@@ -2031,7 +1996,6 @@
    *
    * @param idProp - The expected property to contain item id.
    * @param v - The value to be tested.
-   *
    * @returns True if all expected values and methods match, false otherwise.
    */
   function isDataSetLike(idProp, v) {
@@ -2063,7 +2027,6 @@
    *
    * @param idProp - The expected property to contain item id.
    * @param v - The value to be tested.
-   *
    * @returns True if all expected values and methods match, false otherwise.
    */
   function isDataViewLike(idProp, v) {
@@ -2084,9 +2047,7 @@
 
   Object.defineProperty(exports, 'DELETE', {
     enumerable: true,
-    get: function () {
-      return esnext.DELETE;
-    }
+    get: function () { return esnext.DELETE; }
   });
   exports.DataSet = DataSet;
   exports.DataStream = DataStream;
@@ -2098,5 +2059,5 @@
 
   Object.defineProperty(exports, '__esModule', { value: true });
 
-})));
+}));
 //# sourceMappingURL=vis-data.js.map