Поделиться через

ExcelScript.TableSort interface

  • Ссылка
Пакет:
ExcelScript

Управляет операциями сортировки объектов Table .

Методы

apply(fields, matchCase, method)

Выполняет сортировку.
clear()

Удаляет текущие параметры сортировки таблицы. При этом сбрасывается состояние кнопок в заголовках, но порядок сортировки таблицы остается неизменным.
getFields()

Указывает текущие условия, используемые для последней сортировки таблицы.
getMatchCase()

Указывает, влияет ли регистр на последний тип таблицы.
getMethod()

Представляет метод упорядочения символов на китайском языке, который последний раз использовался для сортировки таблицы.
reapply()

Повторно применяет текущие параметры сортировки к таблице.

Сведения о методе

apply(fields, matchCase, method)

Выполняет сортировку.

apply(
            fields: SortField[],
            matchCase?: boolean,
            method?: SortMethod
        ): void;

Параметры

fields

ExcelScript.SortField[]

Список условий для сортировки.

matchCase

boolean

Необязательный параметр. Указывает, необходимо ли учитывать регистр при сортировке строк.

method
ExcelScript.SortMethod

Необязательный параметр. Метод сортировки, используемый для китайских символов.

Возвращаемое значение

void

Примеры

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

clear()

Удаляет текущие параметры сортировки таблицы. При этом сбрасывается состояние кнопок в заголовках, но порядок сортировки таблицы остается неизменным.

clear(): void;

Возвращаемое значение

void

getFields()

Указывает текущие условия, используемые для последней сортировки таблицы.

getFields(): SortField[];

Возвращаемое значение

ExcelScript.SortField[]

getMatchCase()

Указывает, влияет ли регистр на последний тип таблицы.

getMatchCase(): boolean;

Возвращаемое значение

boolean

getMethod()

Представляет метод упорядочения символов на китайском языке, который последний раз использовался для сортировки таблицы.

getMethod(): SortMethod;

Возвращаемое значение

ExcelScript.SortMethod

reapply()

Повторно применяет текущие параметры сортировки к таблице.

reapply(): void;

Возвращаемое значение

void

Примеры

/**
 * This script reapplies all the current sorting criteria to existing tables.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the tables.
  const tables = workbook.getTables();

  // For each table, reapply that table's current sorting parameters.
  tables.forEach((table) => {
    const sort: ExcelScript.TableSort = table.getSort();
    sort.reapply();
  });
}