BeInspireTreeNodes<TPayload> Interface
Definition of a list of BeInspireTreeNode with some additional filtering methods
Extends
- Array<BeInspireTreeNode<TPayload>>
Methods
| Name | Description | |
|---|---|---|
| collapsed(): BeInspireTreeNodes<TPayload> | ||
| deepest(): BeInspireTreeNodes<TPayload> | ||
| expanded(): BeInspireTreeNodes<TPayload> | ||
| flatten(): BeInspireTreeNodes<TPayload> | ||
| node(id: string): BeInspireTreeNode<TPayload> | undefined | ||
| nodes(ids?: string[]): BeInspireTreeNodes<TPayload> | ||
| selected(): BeInspireTreeNodes<TPayload> | ||
| visible(): BeInspireTreeNodes<TPayload> |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| __@iterator(): IterableIterator<BeInspireTreeNode<TPayload>> | [Array.Symbol | Iterator |
| __@unscopables(): object | [Array.Symbol | Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. |
| concat(...items: ConcatArray<BeInspireTreeNode<TPayload>>[]): BeInspireTreeNode<TPayload>[] | Array | Combines two or more arrays. |
| concat(...items: T | ConcatArray<T>[]): BeInspireTreeNode<TPayload>[] | Array | Combines two or more arrays. |
| copyWithin(target: number, start: number, end?: number): this | Array | Returns the this object after copying a section of the array identified by start and end to the same array starting at position target |
| entries(): IterableIterator<[number, BeInspireTreeNode<TPayload>]> | Array | Returns an iterable of key, value pairs for every entry in the array |
| every(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => boolean, thisArg?: any): boolean | Array | Determines whether all the members of an array satisfy the specified test. |
| fill(value: BeInspireTreeNode<TPayload>, start?: number, end?: number): this | Array | Returns the this object after filling the section identified by start and end with value |
| filter<S extends BeInspireTreeNode<TPayload>>(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => boolean, thisArg?: any): S extends BeInspireTreeNode<TPayload>[] | Array | Returns the elements of an array that meet the condition specified in a callback function. |
| filter(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => any, thisArg?: any): BeInspireTreeNode<TPayload>[] | Array | Returns the elements of an array that meet the condition specified in a callback function. |
| find<S extends BeInspireTreeNode<TPayload>>(predicate: (this: void, value: BeInspireTreeNode<TPayload>, index: number, obj: BeInspireTreeNode<TPayload>[]) => boolean, thisArg?: any): S extends BeInspireTreeNode<TPayload> | undefined | Array | Returns the value of the first element in the array where predicate is true, and undefined otherwise. |
| find(predicate: (value: BeInspireTreeNode<TPayload>, index: number, obj: BeInspireTreeNode<TPayload>[]) => boolean, thisArg?: any): BeInspireTreeNode<TPayload> | undefined | Array | |
| findIndex(predicate: (value: BeInspireTreeNode<TPayload>, index: number, obj: BeInspireTreeNode<TPayload>[]) => boolean, thisArg?: any): number | Array | Returns the index of the first element in the array where predicate is true, and -1 otherwise. |
| forEach(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => void, thisArg?: any): void | Array | Performs the specified action for each element in an array. |
| includes(searchElement: BeInspireTreeNode<TPayload>, fromIndex?: number): boolean | Array | Determines whether an array includes a certain element, returning true or false as appropriate. |
| indexOf(searchElement: BeInspireTreeNode<TPayload>, fromIndex?: number): number | Array | Returns the index of the first occurrence of a value in an array. |
| join(separator?: string): string | Array | Adds all the elements of an array separated by the specified separator string. |
| keys(): IterableIterator<number> | Array | Returns an iterable of keys in the array |
| lastIndexOf(searchElement: BeInspireTreeNode<TPayload>, fromIndex?: number): number | Array | Returns the index of the last occurrence of a specified value in an array. |
| map<U>(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => U, thisArg?: any): U[] | Array | Calls a defined callback function on each element of an array, and returns an array that contains the results. |
| pop(): BeInspireTreeNode<TPayload> | undefined | Array | Removes the last element from an array and returns it. |
| push(...items: BeInspireTreeNode<TPayload>[]): number | Array | Appends new elements to an array, and returns the new length of the array. |
| reduce(callbackfn: (previousValue: BeInspireTreeNode<TPayload>, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => BeInspireTreeNode<TPayload>): BeInspireTreeNode<TPayload> | Array | Calls the specified callback function for all the elements in an array. |
| reduce(callbackfn: (previousValue: BeInspireTreeNode<TPayload>, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => BeInspireTreeNode<TPayload>, initialValue: BeInspireTreeNode<TPayload>): BeInspireTreeNode<TPayload> | Array | |
| reduce<U>(callbackfn: (previousValue: U, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => U, initialValue: U): U | Array | Calls the specified callback function for all the elements in an array. |
| reduceRight(callbackfn: (previousValue: BeInspireTreeNode<TPayload>, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => BeInspireTreeNode<TPayload>): BeInspireTreeNode<TPayload> | Array | Calls the specified callback function for all the elements in an array, in descending order. |
| reduceRight(callbackfn: (previousValue: BeInspireTreeNode<TPayload>, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => BeInspireTreeNode<TPayload>, initialValue: BeInspireTreeNode<TPayload>): BeInspireTreeNode<TPayload> | Array | |
| reduceRight<U>(callbackfn: (previousValue: U, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => U, initialValue: U): U | Array | Calls the specified callback function for all the elements in an array, in descending order. |
| reverse(): BeInspireTreeNode<TPayload>[] | Array | Reverses the elements in an Array. |
| shift(): BeInspireTreeNode<TPayload> | undefined | Array | Removes the first element from an array and returns it. |
| slice(start?: number, end?: number): BeInspireTreeNode<TPayload>[] | Array | Returns a section of an array. |
| some(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => boolean, thisArg?: any): boolean | Array | Determines whether the specified callback function returns true for any element of an array. |
| sort(compareFn?: (a: BeInspireTreeNode<TPayload>, b: BeInspireTreeNode<TPayload>) => number): this | Array | Sorts an array. |
| splice(start: number, deleteCount?: number): BeInspireTreeNode<TPayload>[] | Array | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
| splice(start: number, deleteCount: number, ...items: BeInspireTreeNode<TPayload>[]): BeInspireTreeNode<TPayload>[] | Array | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. |
| toLocaleString(): string | Array | Returns a string representation of an array. |
| toString(): string | Array | Returns a string representation of an array. |
| unshift(...items: BeInspireTreeNode<TPayload>[]): number | Array | Inserts new elements at the start of an array. |
| values(): IterableIterator<BeInspireTreeNode<TPayload>> | Array | Returns an iterable of values in the array |
Properties
| Name | Type | Description | |
|---|---|---|---|
| Array | ArrayConstructor |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| length | number | Array | Gets or sets the length of the array. |
Defined in
Last Updated: 08 January, 2020