API Reference > ui-components > Tree > BeInspireTreeNodes

BeInspireTreeNodes<TPayload> Interface

Definition of a list of BeInspireTreeNode with some additional filtering methods

Extends

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
Symbol.iterator(): IterableIterator<BeInspireTreeNode<TPayload>> Array.Symbol Iterator
Symbol.unscopables(): { copyWithin: boolean, entries: boolean, fill: boolean, find: boolean, findIndex: boolean, keys: boolean, values: boolean } Array.Symbol Returns an object whose properties have the value 'true'
concat(...items: ConcatArray<BeInspireTreeNode<TPayload>>[]): BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> Combines two or more arrays.
concat(...items: T | ConcatArray<T>[]): BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> Combines two or more arrays.
copyWithin(target: number, start: number, end?: number): this Array<BeInspireTreeNode<TPayload>> Returns the this object after copying a section of the array identified by start and end
entries(): IterableIterator<[number, BeInspireTreeNode<TPayload>]> Array<BeInspireTreeNode<TPayload>> Returns an iterable of key, value pairs for every entry in the array
every(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => unknown, thisArg?: any): boolean Array<BeInspireTreeNode<TPayload>> Determines whether all the members of an array satisfy the specified test.
fill(value: BeInspireTreeNode<TPayload>, start?: number, end?: number): this Array<BeInspireTreeNode<TPayload>> 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>[]) => value is S extends BeInspireTreeNode<TPayload>, thisArg?: any): S extends BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> 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>[]) => unknown, thisArg?: any): BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> 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>[]) => value is S extends BeInspireTreeNode<TPayload>, thisArg?: any): S extends BeInspireTreeNode<TPayload> | undefined Array<BeInspireTreeNode<TPayload>> Returns the value of the first element in the array where predicate is true, and undefined
find(predicate: (value: BeInspireTreeNode<TPayload>, index: number, obj: BeInspireTreeNode<TPayload>[]) => unknown, thisArg?: any): BeInspireTreeNode<TPayload> | undefined Array<BeInspireTreeNode<TPayload>>  
findIndex(predicate: (value: BeInspireTreeNode<TPayload>, index: number, obj: BeInspireTreeNode<TPayload>[]) => unknown, thisArg?: any): number Array<BeInspireTreeNode<TPayload>> Returns the index of the first element in the array where predicate is true, and -1
forEach(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => void, thisArg?: any): void Array<BeInspireTreeNode<TPayload>> Performs the specified action for each element in an array.
includes(searchElement: BeInspireTreeNode<TPayload>, fromIndex?: number): boolean Array<BeInspireTreeNode<TPayload>> Determines whether an array includes a certain element, returning true or false as appropriate.
indexOf(searchElement: BeInspireTreeNode<TPayload>, fromIndex?: number): number Array<BeInspireTreeNode<TPayload>> Returns the index of the first occurrence of a value in an array.
join(separator?: string): string Array<BeInspireTreeNode<TPayload>> Adds all the elements of an array separated by the specified separator string.
keys(): IterableIterator<number> Array<BeInspireTreeNode<TPayload>> Returns an iterable of keys in the array
lastIndexOf(searchElement: BeInspireTreeNode<TPayload>, fromIndex?: number): number Array<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>> Calls a defined callback function on each element of an array, and returns an array that contains the results.
pop(): BeInspireTreeNode<TPayload> | undefined Array<BeInspireTreeNode<TPayload>> Removes the last element from an array and returns it.
push(...items: BeInspireTreeNode<TPayload>[]): number Array<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>>  
reduce<U>(callbackfn: (previousValue: U, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => U, initialValue: U): U Array<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>>  
reduceRight<U>(callbackfn: (previousValue: U, currentValue: BeInspireTreeNode<TPayload>, currentIndex: number, array: BeInspireTreeNode<TPayload>[]) => U, initialValue: U): U Array<BeInspireTreeNode<TPayload>> Calls the specified callback function for all the elements in an array, in descending order.
reverse(): BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> Reverses the elements in an Array.
shift(): BeInspireTreeNode<TPayload> | undefined Array<BeInspireTreeNode<TPayload>> Removes the first element from an array and returns it.
slice(start?: number, end?: number): BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> Returns a section of an array.
some(callbackfn: (value: BeInspireTreeNode<TPayload>, index: number, array: BeInspireTreeNode<TPayload>[]) => unknown, thisArg?: any): boolean Array<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>> Sorts an array.
splice(start: number, deleteCount?: number): BeInspireTreeNode<TPayload>[] Array<BeInspireTreeNode<TPayload>> 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<BeInspireTreeNode<TPayload>> Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
toLocaleString(): string Array<BeInspireTreeNode<TPayload>> Returns a string representation of an array.
toString(): string Array<BeInspireTreeNode<TPayload>> Returns a string representation of an array.
unshift(...items: BeInspireTreeNode<TPayload>[]): number Array<BeInspireTreeNode<TPayload>> Inserts new elements at the start of an array.
values(): IterableIterator<BeInspireTreeNode<TPayload>> Array<BeInspireTreeNode<TPayload>> Returns an iterable of values in the array

Properties

Name Type Description
Array ArrayConstructor    

Inherited properties

Name Type Inherited from Description
length number Array<BeInspireTreeNode<TPayload>> Gets or sets the length of the array.

Defined in

Last Updated: 13 June, 2024