ExcelScript.SortField interface
Representa uma condição em uma operação de classificação.
Propriedades
ascending | Especifica se a ordenação é efetuada de forma ascendente. |
color | Especifica a cor que é o destino da condição se a ordenação estiver no tipo de letra ou na cor da célula. |
data |
Representa as opções de classificação adicionais para esse campo. |
icon | Especifica o ícone que é o destino da condição, se a ordenação estiver no ícone da célula. |
key | Especifica a coluna (ou linha, consoante a orientação de ordenação) em que a condição se encontra. Representado como um deslocamento da primeira coluna (ou linha). |
sort |
Especifica o tipo de ordenação desta condição. |
sub |
Especifica o subcampo que é o nome da propriedade de destino de um valor avançado para ordenar. |
Detalhes da propriedade
ascending
Especifica se a ordenação é efetuada de forma ascendente.
ascending?: boolean;
Valor da propriedade
boolean
color
Especifica a cor que é o destino da condição se a ordenação estiver no tipo de letra ou na cor da célula.
color?: string;
Valor da propriedade
string
Exemplos
/**
* This script sorts a range based on the color of the cells.
* It brings all red cells to the top of the range.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the range (A1:D8) to sort from the current worksheet.
const worksheet = workbook.getActiveWorksheet();
const rangeToSort = worksheet.getRange("A1:D8");
// Create a SortField for color sorting.
// This sorts the rows based on the fill color of each row's cell in the first column.
let colorSort: ExcelScript.SortField = {
ascending: true,
color: "FF0000", /* red */
key: 0,
sortOn: ExcelScript.SortOn.cellColor
};
// Apply the SortField to the range.
rangeToSort.getSort().apply([colorSort]);
}
dataOption
Representa as opções de classificação adicionais para esse campo.
dataOption?: SortDataOption;
Valor da propriedade
Exemplos
/**
* This script sorts a table based on the values in column 1.
* If the text of a column-1 value can be treated as a number,
* it will be sorted in numerical order, rather than Unicode order
* (so 123 will come before 12.3).
*/
function main(workbook: ExcelScript.Workbook) {
// Get the first table on the current worksheet.
const currentSheet = workbook.getActiveWorksheet();
const table = currentSheet.getTables()[0];
// Create the sorting parameters.
const countSortField: ExcelScript.SortField = {
key: 1,
ascending: true,
dataOption: ExcelScript.SortDataOption.textAsNumber
};
// Apply the sort to the table.
const sort = table.getSort();
sort.apply([countSortField]);
}
icon
Especifica o ícone que é o destino da condição, se a ordenação estiver no ícone da célula.
icon?: Icon;
Valor da propriedade
key
Especifica a coluna (ou linha, consoante a orientação de ordenação) em que a condição se encontra. Representado como um deslocamento da primeira coluna (ou linha).
key: number;
Valor da propriedade
number
Exemplos
/**
* This script sorts the used range of the current worksheet.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the used range of the current worksheet.
const activeRange = workbook.getActiveWorksheet().getUsedRange();
// Sort the rows in ascending order based on the last column.
activeRange.getSort().apply(
[{
ascending: true,
key: activeRange.getColumnCount() - 1
}],
false, /* Don't match case. */
true, /* Treat the first row as a header rows. */
ExcelScript.SortOrientation.rows
);
}
sortOn
Especifica o tipo de ordenação desta condição.
sortOn?: SortOn;
Valor da propriedade
subField
Especifica o subcampo que é o nome da propriedade de destino de um valor avançado para ordenar.
subField?: string;
Valor da propriedade
string