search string side menu

Таблица

Таблица — это тип переменной, представляющий собой массив данных — строк таблицы. Каждая строка является отдельным элементом массива и представляет собой объект, свойства которого определены столбцами таблицы.

Подробнее про работу с таблицами можете почитать в этой статье.

Type parameters

Hierarchy

  • TTable

Properties

Readonly length

length: number

Свойство TTable.length возвращает число элементов таблицы.

Значение данного свойства — 32-битное беззнаковое целое число, которое всегда больше, чем наибольший индекс в массиве.

Readonly result

result: R

Строка вычисляемого результата в таблице.

В этой строке могут быть настроены вычисления суммы, среднего, количества.

Methods

concat

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

  • Метод TTable.concat возвращает новый массив, состоящий из массива элементов таблицы, соединённого с другими массивами и/или значениями, переданными в качестве аргументов.

    Внимание: возвращаемое значение — это обычный массив, который не является Таблицей.

    Parameters

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

      Массивы и/или значения, соединяемые в новый массив.

    Returns T[]

    Новый массив, содержащий все элементы.

delete

  • delete(index: number): void

  • Метод TTable.delete удаляет конкретную строку из заданной таблицы.

    Parameters

    • index: number

      Целое число, представляющее строку, которую следует удалить.

      // Получаем заказ
const order = await Context.data.orders!.fetch();
// Проходим циклом по каждой строке
for (let i = order.data.content!.length - 1; i >= 0; i--) {
  const row = order.data.content![i];
  // Проверяем, заполнено ли поле «Количество»
  if(!row.amount) {
      // Удаляем строку, если не заполнено
      order.data.content!.delete(i);
  }
}
// Сохраняем заказ
await order.save();

    Returns void

every

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

  • Метод TTable.every проверяет, удовлетворяют ли все элементы таблицы условию, заданному в передаваемой функции.

    Внимание: метод возвращает true при любом условии для пустой таблицы.

    Parameters

    • predicate: function

      Функция проверки каждого элемента. Принимает три аргумента:

        • (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

    Возвращает true, если функция проверки возвращает истинное значение для каждого элемента таблицы. Иначе false.

filter

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

  • Метод TTable.filter создаёт новый массив со всеми элементами, прошедшими проверку, задаваемую в передаваемой функции.

    Внимание: возвращаемое значение — это обычный массив, который не является Таблицей.

    Parameters

    • predicate: function

      Функция-предикат, которая будет вызвана для проверки каждого элемента массива. Если функция возвращает true, то элемент остаётся в массиве, если false, то удаляется.

        • (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[]

    Новый массив с элементами, которые прошли проверку. Если ни один элемент не прошёл проверку, то будет возвращён пустой массив.

find

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

  • Метод TTable.find возвращает значение первого найденного в таблице элемента, которое удовлетворяет условию, переданному в функции predicate. В противном случае возвращается undefined.

    Parameters

    • predicate: function

      Функция, вызывающаяся для каждого значения в таблице.

        • (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

  • Метод TTable.findIndex возвращает индекс в массиве, если элемент удовлетворяет условию проверяющей функции. В противном случае возвращается -1.

    Parameters

    • predicate: function

      Функция, вызывающаяся для каждого значения в таблице.

        • (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

  • Метод TTable.forEach выполняет указанную функцию один раз для каждого элемента в таблице.

    Parameters

    • callback: function

      Функция, которая будет вызвана для каждого элемента массива. Она принимает от одного до трёх аргументов:

        • (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

  • Метод TTable.indexOf возвращает первый индекс, по которому данный элемент может быть найден в таблице, или -1, если такого индекса нет.

    Parameters

    • searchElement: T

      Искомый элемент в массиве.

    • Optional fromIndex: undefined | number

      Индекс, с которого начинать поиск. Если индекс больше или равен длине таблицы, возвращается -1, что означает, что таблица даже не просматривается. Если индекс является отрицательным числом, он трактуется как смещение с конца таблицы. Обратите внимание: если индекс отрицателен, таблица всё равно просматривается от начала к концу. Если рассчитанный индекс оказывается меньше 0, поиск ведётся по всей таблице. Значение по умолчанию равно 0, что означает, что просматривается вся таблица.

    Returns number

insert

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

  • Метод TTable.insert добавляет новую строку в таблицу и возвращает ссылку на неё.

    Parameters

    • Optional index: undefined | number

      Индекс новой строки.

      // Получаем заказ
const order = await Context.data.orders!.fetch();
// Вставляем строку, `row` присваивается ссылка на новую строку
const row = order.data.content!.insert();
// Заполняем строку
row.item = Context.data.product!;
row.amount = Context.data.amount!;
// Сохраняем заказ
await order.save();

    Returns T

    Новая строка таблицы.

join

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

  • Метод TTable.join объединяет все элементы таблицы в строку.

    Parameters

    • Optional separator: undefined | string

      Определяет строку, разделяющую элементы массива. В случае необходимости тип разделителя приводится к типу Строка. Если он не задан, элементы массива разделяются запятой (,). Если разделитель — пустая строка, элементы массива ничем не разделяются в возвращаемой строке.

    Returns string

lastIndexOf

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

  • Метод TTable.lastIndexOf возвращает последний индекс, по которому данный элемент может быть найден в таблице, или -1, если такого индекса нет. Таблица просматривается от конца к началу, начиная с индекса fromIndex.

    Parameters

    • searchElement: T

      Искомый элемент в таблице.

    • Optional fromIndex: undefined | number

      Необязательный параметр. Индекс, с которого начинать поиск в обратном направлении. Если индекс больше или равен длине таблицы, просматривается вся таблица. Если индекс является отрицательным числом, он трактуется как смещение с конца таблицы. Обратите внимание: если индекс отрицателен, таблица всё равно просматривается от конца к началу. Если рассчитанный индекс оказывается меньше 0, таблица даже не просматривается. Значение по умолчанию равно длине таблицы, что означает, что просматривается вся таблица.

    Returns number

map

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

  • Метод TTable.map создаёт новый массив с результатом вызова указанной функции для каждого элемента таблицы.

    Внимание: возвращаемое значение — это обычный массив, который не является Таблицей.

    Type parameters

    • U

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

    Parameters

    • callback: function

      Функция, вызываемая для каждого элемента таблицы. Каждый раз, когда callback выполняется, возвращаемое значение добавляется в новый массив.

        • (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[]

    Новый массив, где каждый элемент является результатом callback функции.

reduce

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

  • Метод TTable.reduce применяет функцию reducer к каждому элементу таблицы (слева направо), возвращая одно результирующее значение.

    Parameters

    • callback: function

      Функция, выполняющаяся для каждого элемента массива.

        • (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

  • Метод TTable.reduce применяет функцию reducer к каждому элементу таблицы (слева направо), возвращая одно результирующее значение.

    Type parameters

    • U

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

    Parameters

    • callback: function

      Функция, выполняющаяся для каждого элемента массива, принимает четыре аргумента:

        • (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

  • Метод TTable.reduceRight применяет функцию к аккумулятору и каждому значению таблицы (справа налево), сводя его к одному значению.

    Parameters

    • callback: function

      Функция, выполняющаяся для каждого элемента таблицы.

        • (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

  • Метод TTable.reduceRight применяет функцию к аккумулятору и каждому значению таблицы (справа налево), сводя его к одному значению.

    Type parameters

    • U

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

    Parameters

    • callback: function

      Функция, выполняющаяся для каждого элемента таблицы.

        • (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[]

  • Метод TTable.slice возвращает новый массив, содержащий копию части исходной таблицы.

    Внимание: возвращаемое значение — это обычный массив, который не является Таблицей.

    Parameters

    • Optional start: undefined | number

      Индекс, по которому необходимо начинать извлечение (счёт начинается с нуля). Если индекс отрицательный, start указывает смещение от конца последовательности. Вызов slice(-2) извлечёт два последних элемента таблицы. Если start не определён, slice() начинает работать с индекса 0. Если start больше длины последовательности, вернётся пустой массив.

    • Optional end: undefined | number

      Индекс, по которому необходимо заканчивать извлечение (счёт начинается с нуля). Метод slice() извлекает элементы с индексом меньше end. Вызов slice(1, 4) извлечёт элементы со второго по четвёртый (элементы по индексам 1, 2 и 3). Если индекс отрицательный, end указывает смещение от конца последовательности. Вызов slice(2, -1) извлечёт из последовательности элементы начиная с третьего элемента с начала и заканчивая вторым с конца. Если end опущен, slice() извлекает все элементы до конца последовательности (table.length).

    Returns T[]

    Новый массив, содержащий выборку элементов таблицы.

some

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

  • Метод TTable.some проверяет, удовлетворяет ли какой-либо элемент таблицы условию, заданному в передаваемой функции.

    Внимание: метод возвращает false при любом условии для пустой таблицы.

    Parameters

    • predicate: function

      Функция проверки каждого элемента. Принимает три аргумента:

        • (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

    Возвращает true, если функция проверки возвращает истинное значение хотя бы для одного элемента таблицы. Иначе false.

toLocaleString

  • toLocaleString(): string

  • Метод TTable.toLocaleString возвращает строковое представление элементов таблицы.

    Элементы преобразуются в строки с использованием своих собственных методов toLocaleString, и эти строки разделяются локалезависимой строкой, например, запятой (,).

    Returns string

toString

  • toString(): string

  • Метод TTable.toString возвращает строковое представление элементов таблицы.

    Для таблицы метод toString соединяет массив и возвращает одну строку, содержащую все элементы массива, разделённые запятыми.

    Returns string