vis-data 7.1.2 → 7.1.3

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.2
- * @date    2021-01-08T20:37:11.601Z
+ * @version 7.1.3
+ * @date    2022-03-02T13:02:54.265Z
  *
  * @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) {
@@ -120,7 +118,6 @@
        * Apply the transformers to the items.
        *
        * @param items - The items to be transformed.
-       *
        * @returns The transformed items.
        */
       _transformItems(items) {
@@ -192,7 +189,6 @@
        *
        * @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 +200,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 +213,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 +225,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 +237,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) {
@@ -293,7 +283,6 @@
        *
        * @param object - The object to be extended.
        * @param options - Additional options.
-       *
        * @returns The created queue.
        */
       static extend(object, options) {
@@ -457,7 +446,6 @@
        * Subscribe to an event, add an event listener.
        *
        * @remarks Non-function callbacks are ignored.
-       *
        * @param event - Event name.
        * @param callback - Callback method.
        */
@@ -471,7 +459,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.
        */
@@ -487,7 +474,6 @@
    * [[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 {
@@ -536,7 +522,6 @@
        *
        * @remarks
        * The array may contain duplicities.
-       *
        * @returns The array with all ids from this stream.
        */
       toIdArray() {
@@ -547,7 +532,6 @@
        *
        * @remarks
        * The array may contain duplicities.
-       *
        * @returns The array with all items from this stream.
        */
       toItemArray() {
@@ -558,7 +542,6 @@
        *
        * @remarks
        * The array may contain duplicities.
-       *
        * @returns The array with all entries from this stream.
        */
       toEntryArray() {
@@ -569,7 +552,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 +605,6 @@
        * ds.clear()
        * chachedStream // Still has all the items.
        * ```
-       *
        * @returns A new [[DataStream]] with cached items (detached from the original [[DataSet]]).
        */
       cache() {
@@ -633,9 +614,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 +628,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 +656,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 +673,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 +697,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 +722,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 +735,6 @@
        * Sort the items.
        *
        * @param callback - Item comparator.
-       *
        * @returns A new stream with sorted items.
        */
       sort(callback) {
@@ -779,13 +750,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) {
@@ -933,9 +901,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 +960,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 +1051,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) {
@@ -1361,9 +1321,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 +1343,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 +1390,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 +1416,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 +1444,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 +1461,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 +1480,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 +1499,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 +1528,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 +1547,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) {
@@ -1709,7 +1658,6 @@
        * 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 +1979,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 +2010,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 +2030,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 +2042,5 @@
 
   Object.defineProperty(exports, '__esModule', { value: true });
 
-})));
+}));
 //# sourceMappingURL=vis-data.js.map