ExcelScript.TableSort interface
Gere operações de ordenação em Table
objetos.
Métodos
apply(fields, match |
Executa uma operação de classificação. |
clear() | Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da tabela, mas limpa o estado dos botões do cabeçalho. |
get |
Especifica as condições atuais utilizadas para ordenar a tabela pela última vez. |
get |
Especifica se a caixa afeta o último tipo da tabela. |
get |
Representa o método de ordenação de carateres chinês utilizado pela última vez para ordenar a tabela. |
reapply() | Reaplica os parâmetros de classificação atuais à tabela. |
Detalhes do método
apply(fields, matchCase, method)
Executa uma operação de classificação.
apply(
fields: SortField[],
matchCase?: boolean,
method?: SortMethod
): void;
Parâmetros
- fields
A lista de condições para a classificação.
- matchCase
-
boolean
Opcional. Define se o uso de maiúsculas ou minúsculas afeta a ordenação da cadeia de caracteres.
- method
- ExcelScript.SortMethod
Opcional. O método de ordenação usado pelos caracteres chineses.
Retornos
void
Exemplos
/**
* 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()
Limpa a classificação que está na tabela. Essa ação não modifica a ordenação da tabela, mas limpa o estado dos botões do cabeçalho.
clear(): void;
Retornos
void
getFields()
Especifica as condições atuais utilizadas para ordenar a tabela pela última vez.
getFields(): SortField[];
Retornos
getMatchCase()
Especifica se a caixa afeta o último tipo da tabela.
getMatchCase(): boolean;
Retornos
boolean
getMethod()
Representa o método de ordenação de carateres chinês utilizado pela última vez para ordenar a tabela.
getMethod(): SortMethod;
Retornos
reapply()
Reaplica os parâmetros de classificação atuais à tabela.
reapply(): void;
Retornos
void
Exemplos
/**
* 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();
});
}