search string side menu

Table

Table is a type of variable that stores an array of data (table rows).
Each row is a separate element of an array. It is an object whose properties are defined by the table’s columns. Read more about working with tables in Getting started with the Table data type.

Type parameters

Hierarchy

  • TTable

Properties

Readonly length

length: number

The TTable.length property returns the number of elements in an array.

The value of this property is an 32-bit unsigned integer that is always greater than the greatest index in the array.

Readonly result

result: R

String with the calculated result in the table.

In this string, the calculation of the total, the average, or the number of elements can be set.

Methods

concat

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

  • The method returns a new array that includes the array of table elements concatenated with other arrays and/or values passed as arguments.

    Important: the returned value is a regular array, not a table.

    Parameters

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

      Arrays and/or values to be concatenated into a new array.

    Returns T[]

    A new array containing all the elements.

delete

  • delete(index: number): void

  • The method deletes a specific row from a table.

    Parameters

    • index: number

      An integer that represents the row to be deleted.

      // Getting  an order 
const order = await Context.data.orders!.fetch(); 
// Executing a  loop for each row 
for (let i = order.data.content!.length - 1; i >= 0; i--)  { 
  const row = order.data.content![i]; 
  // / Checking if the Amount  field is filled out 
  if(!row.amount) { 
      // Deleting the row if it is  empty 
      order.data.content!.delete(i); 
  } 
} 
// Saving the order  
await order.save();

    Returns void

every

  • every(predicate: function, thisArg?: any): boolean

  • The method tests whether at least one element in the array passes the test implemented by the callback function.

    Important: the method returns true when applied to an empty table, no matter the conditions.

    Parameters

    • predicate: function

      The function that tests each element. It accepts three arguments:

        • (value: T, index: number, array: readonly T[]): unknown

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns unknown

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции predicate.

    Returns boolean

    Returns true if the checking function returns true for each element of the table. Otherwise, returns false.

filter

  • filter(predicate: function, thisArg?: any): T[]

  • The method creates a new array consisting of all the elements that meet the conditions set in the callback function.

    Important: the returned value is a regular array, not a table.

    Parameters

    • predicate: function

      A predicate function that tests each element of an array. If the function returns true for an element, it stays in the array. If it returns false, the element is deleted.

        • (value: T, index: number, array: readonly T[]): unknown

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns unknown

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции predicate.

    Returns T[]

    A new array with elements that met the conditions. If no elements meet the conditions, an empty array will be returned.

find

  • find(predicate: function, thisArg?: any): T | undefined

  • The method returns the value of the item in the table that is the first one to meet the conditions passed in the predicate function. Otherwise, it returns undefined.

    Parameters

    • predicate: function

      A function executed for each value in a table.

        • (value: T, index: number, array: readonly T[]): unknown

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns unknown

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции predicate.

    Returns T | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • The method returns an index in an array if the item meets the conditions set in the checking function. Otherwise, it returns -1.

    Parameters

    • predicate: function

      A function executed for each value in a table.

        • (value: T, index: number, array: readonly T[]): unknown

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns unknown

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции predicate.

    Returns number

forEach

  • forEach(callback: function, thisArg?: any): void

  • The method runs a callback function once for each element in a table.

    Parameters

    • callback: function

      A function executed for each element of an array. If accepts from one to four arguments:

        • (value: T, index: number, array: readonly T[]): void

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns void

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции callback.

    Returns void

indexOf

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

  • The method returns the first index that a given item can be found in the table, or it returns -1 if no such index exists.

    Parameters

    • searchElement: T

      Element in the array that needs to be found.

    • Optional fromIndex: undefined | number

      Index that search needs to start with. If this index is greater than or equal to the length of the table, the method returns -1, which means that the table is not processed at all. If the value in this parameter is a negative number, it determines the offset from the end of the table. Note that if the value is negative, the order that elements are processed in is still the same: from beginning to end. If the index calculated based on this parameter is lower than zero, the search is performed for the whole table. By default, the value is 0, which means that the entire table is processed.

    Returns number

insert

  • insert(index?: undefined | number): T

  • The method adds a new row to a table and returns a link to it.

    Parameters

    • Optional index: undefined | number

      Index of the new row. 

      // Getting an order 
const order =  await Context.data.orders!.fetch(); 
// Inserting a new row, and `row` is  assigned a link to this row 
const row = order.data.content!.insert(); 
//  Filling in the row 
row.item = Context.data.product!; 
row.amount = Context. data.amount!; 
// Saving the order 
await order.save();

    Returns T

    A new table row.

join

  • join(separator?: undefined | string): string

  • The method concatenates all the elements in a string.

    Parameters

    • Optional separator: undefined | string

      Specifies a string to separate each pair of adjacent elements of the array. The separator is converted to a string if necessary. If omitted, the array elements are separated with a comma (,). If the separator is an empty string, all elements are joined without any characters in between them.

    Returns string

lastIndexOf

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

  • The method returns the last index that a given item in the table has. Or it returns -1 if no such index exists. The table is processed from the end to the beginning, starting with fromIndex.

    Parameters

    • searchElement: T

      Element in the table that needs to be found.

    • Optional fromIndex: undefined | number

      This parameter is optional. The index at which to start searching backwards.
      If the index is greater or equal to the length of the table, the whole table is processed. If the passed value is a negative number, it determines the offset from the end of the table. Note that if the value is negative, the table is still processed from the end to the beginning. If the value of the calculated index is lower than zero, the table is not processed at all.
      The default value is equal to the table’s length, which means that the whole table is processed.

    Returns number

map

  • map<U>(callback: function, thisArg?: any): U[]

  • The method creates a new array with the result of calling the function passed as the callback for each element in a table.

    Important: the returned value is a regular array, not a table.

    Type parameters

    • U

      Тип элемента возвращаемого массива.

    Parameters

    • callback: function

      A function called for each element in the table. Each time the callback function is executed, the returned value is added to the new array.

        • (value: T, index: number, array: readonly T[]): U

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns U

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции callback.

    Returns U[]

    A new array with each element being the result of the callback function.

reduce

  • reduce(callback: function, initialValue?: T): T
  • reduce<U>(callback: function, initialValue?: U): U

  • The method applies the reducer function to each element of the table (from left to right) and returns a single resulting value.

    Parameters

    • callback: function

      A function executed for each element of an array. It accepts four arguments:

        • (previousValue: T, currentValue: T, index: number, array: readonly T[]): T

        • Parameters

          • previousValue: T

            Аккумулятор значения, которое возвращает функция callback после посещения очередного элемента, либо значение initialValue, если оно предоставлено.

          • currentValue: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns T

    • Optional initialValue: T

      Необязательный параметр. Объект, используемый в качестве первого аргумента при первом вызове функции callback.

    Returns T

  • The method applies the reducer function to each element of the table (from left to right) and returns a single resulting value.

    Type parameters

    • U

      Тип возвращаемого значения.

    Parameters

    • callback: function

      A function executed for each element of an array. It accepts four arguments:

        • (previousValue: U, currentValue: T, index: number, array: readonly T[]): U

        • Parameters

          • previousValue: U

            Аккумулятор значения, которое возвращает функция callback после посещения очередного элемента, либо значение initialValue, если оно предоставлено.

          • currentValue: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns U

    • Optional initialValue: U

      Необязательный параметр. Объект, используемый в качестве первого аргумента при первом вызове функции callback.

    Returns U

reduceRight

  • reduceRight(callback: function, initialValue?: T): T
  • reduceRight<U>(callback: function, initialValue?: U): U

  • The method applies a function against an accumulator and each value of the array (from right to left) to reduce it to a single value.

    Parameters

    • callback: function

      A function executed for each element of a table.

        • (previousValue: T, currentValue: T, index: number, array: readonly T[]): T

        • Parameters

          • previousValue: T

            Аккумулятор значения, которое возвращает функция callback после посещения очередного элемента, либо значение initialValue, если оно предоставлено.

          • currentValue: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns T

    • Optional initialValue: T

      Необязательный параметр. Объект, используемый в качестве первого аргумента при первом вызове функции callback.

    Returns T

  • The method applies a function against an accumulator and each value of the array (from right to left) to reduce it to a single value.

    Type parameters

    • U

      Тип возвращаемого значения.

    Parameters

    • callback: function

      A function executed for each element of a table.

        • (previousValue: U, currentValue: T, index: number, array: readonly T[]): U

        • Parameters

          • previousValue: U

            Аккумулятор значения, которое возвращает функция callback после посещения очередного элемента, либо значение initialValue, если оно предоставлено.

          • currentValue: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns U

    • Optional initialValue: U

      Необязательный параметр. Объект, используемый в качестве первого аргумента при первом вызове функции callback.

    Returns U

slice

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

  • The method returns a new array containing a shallow copy of a portion of the initial array.

    Important: the returned value is a regular array, not a table.

    Parameters

    • Optional start: undefined | number

      The index that extracting needs to finish with (the numbering starts with zero). If the value is a negative number, start determines the offset from the end of the sequence. If you call slice(-2), the last two elements in the table will be extracted. If start is not defined, slice() starts with index 0. If start is greater than the length of the sequence, an empty array will be returned.

    • Optional end: undefined | number

      The index that extracting needs to finish with (the numbering starts with zero). The slice() method extracts elements that have indexes with a lower value than the one specified in end. If you call slice(1,4), elements from the second to the fourth will be extracted (elements with indexes 1, 2, and 3). If the value is a negative number, end will determine the offset from the end of the sequence. If you call slice(2,-1) , elements from the third element to the second one from the end will be extracted. If no value is passed to end, slice() returns all elements up to the end of the sequence (table.length).

    Returns T[]

    A new array containing the extracted table elements.

some

  • some(predicate: function, thisArg?: any): boolean

  • The method tests whether at least one element in the array passes the test implemented by the callback function.

    Important: the method returns false when applied to an empty table, no matter the conditions.

    Parameters

    • predicate: function

      The function that tests each element. It accepts three arguments:

        • (value: T, index: number, array: readonly T[]): unknown

        • Parameters

          • value: T

            Текущий обрабатываемый элемент таблицы.

          • index: number

            Индекс текущего обрабатываемого элемента таблицы.

          • array: readonly T[]

            Таблица, по которой осуществляется проход.

          Returns unknown

    • Optional thisArg: any

      Необязательный параметр. Значение, используемое в качестве this при выполнении функции predicate.

    Returns boolean

    Returns true if the checking function returns true for at least one element of the table. Otherwise, returns false.

toLocaleString

  • toLocaleString(): string

  • The method returns a string representing the elements of the table.

    Elements are transformed into strings with their own toLocaleString methods, and these strings are separated with a locale-specific string, for example, with a comma (,).

    Returns string

toString

  • toString(): string

  • The method returns a string representing the elements of the table.

    For a table, the toString() method concatenates elements of an array and returns one string containing all elements separated by commas.

    Returns string