vis-data 7.1.2 → 7.1.3

package/esnext/esm/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
@@ -32,7 +32,6 @@ import { v4 } from 'uuid';
  * Create new data pipe.
  *
  * @param from - The source data set or data view.
- *
  * @remarks
  * Example usage:
  * ```typescript
@@ -59,7 +58,6 @@ import { v4 } from 'uuid';
  *
  * pipe.start();
  * ```
- *
  * @returns A factory whose methods can be used to configure the pipe.
  */
 function createNewDataPipeFrom(from) {
@@ -119,7 +117,6 @@ class SimpleDataPipe {
      * Apply the transformers to the items.
      *
      * @param items - The items to be transformed.
-     *
      * @returns The transformed items.
      */
     _transformItems(items) {
@@ -191,7 +188,6 @@ class DataPipeUnderConstruction {
      *
      * @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) {
@@ -203,10 +199,8 @@ class DataPipeUnderConstruction {
      *
      * @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) {
@@ -218,10 +212,8 @@ class DataPipeUnderConstruction {
      *
      * @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) {
@@ -232,7 +224,6 @@ class DataPipeUnderConstruction {
      * 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.
      */
@@ -245,7 +236,6 @@ class DataPipeUnderConstruction {
  * 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) {
@@ -292,7 +282,6 @@ class Queue {
      *
      * @param object - The object to be extended.
      * @param options - Additional options.
-     *
      * @returns The created queue.
      */
     static extend(object, options) {
@@ -456,7 +445,6 @@ class DataSetPart {
      * Subscribe to an event, add an event listener.
      *
      * @remarks Non-function callbacks are ignored.
-     *
      * @param event - Event name.
      * @param callback - Callback method.
      */
@@ -470,7 +458,6 @@ class DataSetPart {
      * 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.
      */
@@ -486,7 +473,6 @@ class DataSetPart {
  * [[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 {
@@ -535,7 +521,6 @@ class DataStream {
      *
      * @remarks
      * The array may contain duplicities.
-     *
      * @returns The array with all ids from this stream.
      */
     toIdArray() {
@@ -546,7 +531,6 @@ class DataStream {
      *
      * @remarks
      * The array may contain duplicities.
-     *
      * @returns The array with all items from this stream.
      */
     toItemArray() {
@@ -557,7 +541,6 @@ class DataStream {
      *
      * @remarks
      * The array may contain duplicities.
-     *
      * @returns The array with all entries from this stream.
      */
     toEntryArray() {
@@ -568,7 +551,6 @@ class DataStream {
      *
      * @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() {
@@ -622,7 +604,6 @@ class DataStream {
      * ds.clear()
      * chachedStream // Still has all the items.
      * ```
-     *
      * @returns A new [[DataStream]] with cached items (detached from the original [[DataSet]]).
      */
     cache() {
@@ -632,9 +613,7 @@ class DataStream {
      * 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) {
@@ -648,7 +627,6 @@ class DataStream {
      * 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) {
@@ -677,9 +655,7 @@ class DataStream {
      * 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) {
@@ -696,7 +672,6 @@ class DataStream {
      * 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) {
@@ -721,7 +696,6 @@ class DataStream {
      * 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) {
@@ -747,9 +721,7 @@ class DataStream {
      *
      * @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) {
@@ -762,7 +734,6 @@ class DataStream {
      * Sort the items.
      *
      * @param callback - Item comparator.
-     *
      * @returns A new stream with sorted items.
      */
     sort(callback) {
@@ -778,13 +749,10 @@ class DataStream {
  *
  * @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) {
@@ -932,9 +900,7 @@ class DataSet extends DataSetPart {
      *
      * @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) {
@@ -993,12 +959,9 @@ class DataSet extends DataSetPart {
      *
      * ## 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) {
@@ -1087,12 +1050,9 @@ class DataSet extends DataSetPart {
      *
      * 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) {
@@ -1360,9 +1320,7 @@ class DataSet extends DataSetPart {
      *
      * @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) {
@@ -1384,7 +1342,6 @@ class DataSet extends DataSetPart {
      *
      * @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) {
@@ -1432,7 +1389,6 @@ class DataSet extends DataSetPart {
      *
      * @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) {
@@ -1459,7 +1415,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1488,7 +1443,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1506,7 +1460,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1526,7 +1479,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1546,7 +1498,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1576,7 +1527,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1596,7 +1546,6 @@ class DataSet extends DataSetPart {
      * 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) {
@@ -1708,7 +1657,6 @@ class DataView extends DataSetPart {
      * 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
@@ -2030,7 +1978,6 @@ class DataView extends DataSetPart {
  *
  * @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) {
@@ -2062,7 +2009,6 @@ function isDataSetLike(idProp, v) {
  *
  * @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) {