ExcelScript.TableSort interface
Administra las operaciones de ordenación en Table
objetos.
Métodos
apply(fields, match |
Realizar una operación de ordenación. |
clear() | Borra la ordenación que se aplica actualmente en la tabla. Aunque esto no modifica la ordenación de la tabla, borra el estado de los botones de encabezado. |
get |
Especifica las condiciones actuales usadas para ordenar por última vez la tabla. |
get |
Especifica si el uso de mayúsculas y minúsculas afecta al último tipo de tabla. |
get |
Representa el método de ordenación de caracteres chino que se usó por última vez para ordenar la tabla. |
reapply() | Vuelve a aplicar los parámetros de ordenación actuales a la tabla. |
Detalles del método
apply(fields, matchCase, method)
Realizar una operación de ordenación.
apply(
fields: SortField[],
matchCase?: boolean,
method?: SortMethod
): void;
Parámetros
- fields
La lista de condiciones por las que realizar la ordenación.
- matchCase
-
boolean
Opcional. Indica si la ordenación de cadenas distingue mayúsculas de minúsculas.
- method
- ExcelScript.SortMethod
Opcional. Método de ordenación que se usa para los caracteres chinos.
Devoluciones
void
Ejemplos
/**
* 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()
Borra la ordenación que se aplica actualmente en la tabla. Aunque esto no modifica la ordenación de la tabla, borra el estado de los botones de encabezado.
clear(): void;
Devoluciones
void
getFields()
Especifica las condiciones actuales usadas para ordenar por última vez la tabla.
getFields(): SortField[];
Devoluciones
getMatchCase()
Especifica si el uso de mayúsculas y minúsculas afecta al último tipo de tabla.
getMatchCase(): boolean;
Devoluciones
boolean
getMethod()
Representa el método de ordenación de caracteres chino que se usó por última vez para ordenar la tabla.
getMethod(): SortMethod;
Devoluciones
reapply()
Vuelve a aplicar los parámetros de ordenación actuales a la tabla.
reapply(): void;
Devoluciones
void
Ejemplos
/**
* 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();
});
}