vis-data 7.1.9 → 7.1.10

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.9
- * @date    2023-11-24T17:53:34.179Z
+ * @version 7.1.10
+ * @date    2025-07-06T08:42:20.006Z
  *
  * @copyright (c) 2011-2017 Almende B.V, http://almende.com
  * @copyright (c) 2017-2019 visjs contributors, https://github.com/visjs
@@ -31,7 +31,6 @@
 })(this, (function (exports, esnext, uuid) {
   /**
    * Create new data pipe.
-   *
    * @param from - The source data set or data view.
    * @remarks
    * Example usage:
@@ -67,7 +66,6 @@
   /**
    * Internal implementation of the pipe. This should be accessible only through
    * `createNewDataPipeFrom` from the outside.
-   *
    * @typeParam SI - Source item type.
    * @typeParam SP - Source item type's id property name.
    * @typeParam TI - Target item type.
@@ -87,7 +85,6 @@
       };
       /**
        * Create a new data pipe.
-       *
        * @param _source - The data set or data view that will be observed.
        * @param _transformers - An array of transforming functions to be used to
        * filter or transform the items in the pipe.
@@ -119,7 +116,6 @@
       }
       /**
        * Apply the transformers to the items.
-       *
        * @param items - The items to be transformed.
        * @returns The transformed items.
        */
@@ -130,7 +126,6 @@
       }
       /**
        * Handle an add event.
-       *
        * @param _name - Ignored.
        * @param payload - The payload containing the ids of the added items.
        */
@@ -142,7 +137,6 @@
       }
       /**
        * Handle an update event.
-       *
        * @param _name - Ignored.
        * @param payload - The payload containing the ids of the updated items.
        */
@@ -154,7 +148,6 @@
       }
       /**
        * Handle a remove event.
-       *
        * @param _name - Ignored.
        * @param payload - The payload containing the data of the removed items.
        */
@@ -168,7 +161,6 @@
   /**
    * Internal implementation of the pipe factory. This should be accessible
    * only through `createNewDataPipeFrom` from the outside.
-   *
    * @typeParam TI - Target item type.
    * @typeParam TP - Target item type's id property name.
    */
@@ -182,7 +174,6 @@
       /**
        * Create a new data pipe factory. This is an internal constructor that
        * should never be called from outside of this file.
-       *
        * @param _source - The source data set or data view for this pipe.
        */
       constructor(_source) {
@@ -190,7 +181,6 @@
       }
       /**
        * 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.
@@ -201,7 +191,6 @@
       }
       /**
        * Map each source item to a new type.
-       *
        * @param callback - A mapping function that takes a source item and returns
        * corresponding mapped item.
        * @typeParam TI - Target item type.
@@ -214,7 +203,6 @@
       }
       /**
        * Map each source item to zero or more items of a new type.
-       *
        * @param callback - A mapping function that takes a source item and returns
        * an array of corresponding mapped items.
        * @typeParam TI - Target item type.
@@ -227,7 +215,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.
@@ -239,7 +226,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.
    */
@@ -249,7 +235,6 @@
 
   /**
    * A queue.
-   *
    * @typeParam T - The type of method names to be replaced by queued versions.
    */
   class Queue {
@@ -262,7 +247,6 @@
       _extended = null;
       /**
        * Construct a new Queue.
-       *
        * @param options - Queue configuration.
        */
       constructor(options) {
@@ -273,7 +257,6 @@
       }
       /**
        * Update the configuration of the queue.
-       *
        * @param options - Queue configuration.
        */
       setOptions(options) {
@@ -288,7 +271,6 @@
       /**
        * Extend an object with queuing functionality.
        * The object will be extended with a function flush, and the methods provided in options.replace will be replaced with queued ones.
-       *
        * @param object - The object to be extended.
        * @param options - Additional options.
        * @returns The created queue.
@@ -349,7 +331,6 @@
       }
       /**
        * Replace a method on an object with a queued version.
-       *
        * @param object - Object having the method.
        * @param method - The method name.
        */
@@ -371,7 +352,6 @@
       }
       /**
        * Queue a call.
-       *
        * @param entry - The function or entry to be queued.
        */
       queue(entry) {
@@ -414,7 +394,6 @@
 
   /**
    * {@link DataSet} code that can be reused in {@link DataView} or other similar implementations of {@link DataInterface}.
-   *
    * @typeParam Item - Item type that may or may not have an id.
    * @typeParam IdProp - Name of the property that contains the id.
    */
@@ -427,7 +406,6 @@
       };
       /**
        * Trigger an event
-       *
        * @param event - Event name.
        * @param payload - Event payload.
        * @param senderId - Id of the sender.
@@ -442,7 +420,6 @@
       }
       /**
        * Subscribe to an event, add an event listener.
-       *
        * @remarks Non-function callbacks are ignored.
        * @param event - Event name.
        * @param callback - Callback method.
@@ -455,7 +432,6 @@
       }
       /**
        * 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.
@@ -475,7 +451,6 @@
 
   /**
    * Data stream
-   *
    * @remarks
    * {@link DataStream} offers an always up to date stream of items from a {@link DataSet} or {@link DataView}.
    * That means that the stream is evaluated at the time of iteration, conversion to another data type or when {@link cache} is called, not when the {@link DataStream} was created.
@@ -486,7 +461,6 @@
       _pairs;
       /**
        * Create a new data stream.
-       *
        * @param pairs - The id, item pairs.
        */
       constructor(pairs) {
@@ -526,7 +500,6 @@
       }
       /**
        * Return an array containing all the ids in this stream.
-       *
        * @remarks
        * The array may contain duplicities.
        * @returns The array with all ids from this stream.
@@ -536,7 +509,6 @@
       }
       /**
        * Return an array containing all the items in this stream.
-       *
        * @remarks
        * The array may contain duplicities.
        * @returns The array with all items from this stream.
@@ -546,7 +518,6 @@
       }
       /**
        * Return an array containing all the entries in this stream.
-       *
        * @remarks
        * The array may contain duplicities.
        * @returns The array with all entries from this stream.
@@ -556,7 +527,6 @@
       }
       /**
        * Return an object map containing all the items in this stream accessible by ids.
-       *
        * @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.
@@ -570,7 +540,6 @@
       }
       /**
        * Return a map containing all the items in this stream accessible by ids.
-       *
        * @returns The map of all id → item pairs from this stream.
        */
       toMap() {
@@ -578,7 +547,6 @@
       }
       /**
        * Return a set containing all the (unique) ids in this stream.
-       *
        * @returns The set of all ids from this stream.
        */
       toIdSet() {
@@ -586,7 +554,6 @@
       }
       /**
        * Return a set containing all the (unique) items in this stream.
-       *
        * @returns The set of all items from this stream.
        */
       toItemSet() {
@@ -594,7 +561,6 @@
       }
       /**
        * Cache the items from this stream.
-       *
        * @remarks
        * This method allows for items to be fetched immediatelly and used (possibly multiple times) later.
        * It can also be used to optimize performance as {@link DataStream} would otherwise reevaluate everything upon each iteration.
@@ -619,7 +585,6 @@
       }
       /**
        * 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.
@@ -633,7 +598,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.
        */
@@ -651,7 +615,6 @@
       }
       /**
        * Execute a callback for each item of the stream.
-       *
        * @param callback - The function that will be invoked for each item.
        */
       forEach(callback) {
@@ -661,7 +624,6 @@
       }
       /**
        * 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.
@@ -678,7 +640,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.
        */
@@ -702,7 +663,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.
        */
@@ -726,7 +686,6 @@
       }
       /**
        * Reduce the items into a single value.
-       *
        * @param callback - The function that does the reduction.
        * @param accumulator - The initial value of the accumulator.
        * @typeParam T - The type of the accumulated value.
@@ -740,7 +699,6 @@
       }
       /**
        * Sort the items.
-       *
        * @param callback - Item comparator.
        * @returns A new stream with sorted items.
        */
@@ -754,7 +712,6 @@
 
   /**
    * Add an id to given item if it doesn't have one already.
-   *
    * @remarks
    * The item will be modified.
    * @param item - The item that will have an id after a call to this function.
@@ -792,15 +749,15 @@
    * // add items
    * // note that the data items can contain different properties and data formats
    * data.add([
-   *   {id: 1, text: 'item 1', date: new Date(2013, 6, 20), group: 1, first: true},
-   *   {id: 2, text: 'item 2', date: '2013-06-23', group: 2},
-   *   {id: 3, text: 'item 3', date: '2013-06-25', group: 2},
-   *   {id: 4, text: 'item 4'}
+   * {id: 1, text: 'item 1', date: new Date(2013, 6, 20), group: 1, first: true},
+   * {id: 2, text: 'item 2', date: '2013-06-23', group: 2},
+   * {id: 3, text: 'item 3', date: '2013-06-25', group: 2},
+   * {id: 4, text: 'item 4'}
    * ]);
    *
    * // subscribe to any change in the DataSet
    * data.on('*', function (event, properties, senderId) {
-   *   console.log('event', event, properties);
+   * console.log('event', event, properties);
    * });
    *
    * // update an existing item
@@ -819,13 +776,12 @@
    *
    * // retrieve a filtered subset of the data
    * var items = data.get({
-   *   filter: function (item) {
-   *     return item.group == 1;
-   *   }
+   * filter: function (item) {
+   * return item.group == 1;
+   * }
    * });
    * console.log('filtered items', items);
    * ```
-   *
    * @typeParam Item - Item type that may or may not have an id.
    * @typeParam IdProp - Name of the property that contains the id.
    */
@@ -844,7 +800,6 @@
       _queue = null;
       /**
        * Construct a new DataSet.
-       *
        * @param data - Initial data or options.
        * @param options - Options (type error if data is also options).
        */
@@ -867,7 +822,6 @@
       }
       /**
        * Set new options.
-       *
        * @param options - The new options.
        */
       setOptions(options) {
@@ -905,14 +859,13 @@
        *
        * // add items
        * const ids = data.add([
-       *   { id: 1, text: 'item 1' },
-       *   { id: 2, text: 'item 2' },
-       *   { text: 'item without an id' }
+       * { id: 1, text: 'item 1' },
+       * { id: 2, text: 'item 2' },
+       * { text: 'item without an id' }
        * ])
        *
        * console.log(ids) // [1, 2, '<UUIDv4>']
        * ```
-       *
        * @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.
@@ -947,7 +900,6 @@
       }
       /**
        * Update existing items. When an item does not exist, it will be created.
-       *
        * @remarks
        * The provided properties will be merged in the existing item. When an item does not exist, it will be created.
        *
@@ -1038,7 +990,6 @@
       }
       /**
        * Update existing items. When an item does not exist, an error will be thrown.
-       *
        * @remarks
        * The provided properties will be deeply merged into the existing item.
        * When an item does not exist (id not present in the data set or absent), an error will be thrown and nothing will be changed.
@@ -1332,7 +1283,6 @@
       }
       /**
        * Filter the fields of an item.
-       *
        * @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.
@@ -1354,7 +1304,6 @@
       }
       /**
        * Sort the provided array with items.
-       *
        * @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.
@@ -1391,9 +1340,9 @@
        * ```javascript
        * // create a DataSet
        * const data = new vis.DataSet([
-       *   { id: 1, text: 'item 1' },
-       *   { id: 2, text: 'item 2' },
-       *   { id: 3, text: 'item 3' }
+       * { id: 1, text: 'item 1' },
+       * { id: 2, text: 'item 2' },
+       * { id: 3, text: 'item 3' }
        * ])
        *
        * // remove items
@@ -1401,7 +1350,6 @@
        *
        * console.log(ids) // [2, 3]
        * ```
-       *
        * @param id - One or more items or ids of items to be removed.
        * @param senderId - Sender id.
        * @returns The ids of the removed items.
@@ -1428,7 +1376,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.
        */
@@ -1456,7 +1403,6 @@
        * Clear the entire data set.
        *
        * After the items are removed, the {@link 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.
        */
@@ -1473,7 +1419,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.
        */
@@ -1492,7 +1437,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.
        */
@@ -1511,7 +1455,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.
        */
@@ -1540,7 +1483,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.
        */
@@ -1559,7 +1501,6 @@
       /**
        * Update a single item: merge with existing item.
        * 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.
        */
@@ -1611,25 +1552,25 @@
    * // create a DataSet
    * var data = new vis.DataSet();
    * data.add([
-   *   {id: 1, text: 'item 1', date: new Date(2013, 6, 20), group: 1, first: true},
-   *   {id: 2, text: 'item 2', date: '2013-06-23', group: 2},
-   *   {id: 3, text: 'item 3', date: '2013-06-25', group: 2},
-   *   {id: 4, text: 'item 4'}
+   * {id: 1, text: 'item 1', date: new Date(2013, 6, 20), group: 1, first: true},
+   * {id: 2, text: 'item 2', date: '2013-06-23', group: 2},
+   * {id: 3, text: 'item 3', date: '2013-06-25', group: 2},
+   * {id: 4, text: 'item 4'}
    * ]);
    *
    * // create a DataView
    * // the view will only contain items having a property group with value 1,
    * // and will only output fields id, text, and date.
    * var view = new vis.DataView(data, {
-   *   filter: function (item) {
-   *     return (item.group == 1);
-   *   },
-   *   fields: ['id', 'text', 'date']
+   * filter: function (item) {
+   * return (item.group == 1);
+   * },
+   * fields: ['id', 'text', 'date']
    * });
    *
    * // subscribe to any change in the DataView
    * view.on('*', function (event, properties, senderId) {
-   *   console.log('event', event, properties);
+   * console.log('event', event, properties);
    * });
    *
    * // update an item in the data set
@@ -1642,7 +1583,6 @@
    * // get all items in the view
    * var items = view.get();
    * ```
-   *
    * @typeParam Item - Item type that may or may not have an id.
    * @typeParam IdProp - Name of the property that contains the id.
    */
@@ -1659,7 +1599,6 @@
       _options;
       /**
        * Create a DataView.
-       *
        * @param data - The instance containing data (directly or indirectly).
        * @param options - Options to configure this data view.
        */
@@ -1673,7 +1612,6 @@
       // 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
@@ -1886,7 +1824,6 @@
       }
       /**
        * Render the instance unusable prior to garbage collection.
-       *
        * @remarks
        * The intention of this method is to help discover scenarios where the data
        * view is being used when the programmer thinks it has been garbage collected
@@ -1912,7 +1849,6 @@
       }
       /**
        * Event listener. Will propagate all events from the connected data set to the subscribers of the DataView, but will filter the items and only trigger when there are changes in the filtered data set.
-       *
        * @param event - The name of the event.
        * @param params - Parameters of the event.
        * @param senderId - Id supplied by the sender.
@@ -1993,7 +1929,6 @@
 
   /**
    * Check that given value is compatible with Vis Data Set interface.
-   *
    * @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.
@@ -2024,7 +1959,6 @@
 
   /**
    * Check that given value is compatible with Vis Data View interface.
-   *
    * @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.