Wijmo
5.20231.904
wijmo Class ArrayBase Wijmo API Class

ArrayBase Class

Base class for Array classes with notifications.

Type parameters

  • T

Heirarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Methods

at

  • at(index: number): T | undefined

  • Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.

    Parameters

    • index: number

    Returns T | undefined

concat

  • concat(...items: ConcatArray<T>[]): T[]
  • concat(...items: (T | ConcatArray<T>)[]): T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<T>[]

      Additional items to add to the end of array1.

    Returns T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns T[]

entries

  • entries(): IterableIterator<[number, T]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, T]>

every

  • every(callbackfn: Object, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

filter

  • filter<S>(callbackfn: Object, thisArg?: any): S[]
  • filter(callbackfn: Object, thisArg?: any): T[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: T

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns T[]

forEach

  • forEach(callbackfn: Object, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

indexOf

  • indexOf(searchElement: T, fromIndex?: number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: Object, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): T | undefined

  • Removes the last element from an array and returns it.

    Returns T | undefined

push

  • push(...items: T[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: T[]

      New elements of the Array.

    Returns number

reverse

  • reverse(): T[]

  • Reverses the elements in an Array.

    Returns T[]

shift

  • shift(): T | undefined

  • Removes the first element from an array and returns it.

    Returns T | undefined

slice

  • slice(start?: number, end?: number): T[]

  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array.

    Returns T[]

some

  • some(callbackfn: Object, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: Object

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: Object): this

  • Sorts an array.

    Parameters

    • Optional compareFn: Object

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: number): T[]
  • splice(start: number, deleteCount: number, ...items: T[]): T[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns T[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: T[]

      Elements to insert into the array in place of the deleted elements.

    Returns T[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: T[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: T[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<T>

  • Returns an iterable of values in the array

    Returns IterableIterator<T>