ExcelScript.SortField interface
Représente une condition dans une opération de tri.
Propriétés
ascending | Spécifie si le tri est effectué par ordre croissant. |
color | Spécifie la couleur qui est la cible de la condition si le tri est sur la couleur de police ou de cellule. |
data |
Options de tri supplémentaires pour ce champ. |
icon | Spécifie l’icône qui est la cible de la condition, si le tri se trouve sur l’icône de la cellule. |
key | Spécifie la colonne (ou la ligne, selon l’orientation de tri) sur laquelle la condition se trouve. Représentée sous forme d’un décalage par rapport à la première colonne (ou ligne). |
sort |
Spécifie le type de tri de cette condition. |
sub |
Spécifie le sous-champ qui est le nom de propriété cible d’une valeur enrichie sur laquelle effectuer le tri. |
Détails de la propriété
ascending
Spécifie si le tri est effectué par ordre croissant.
ascending?: boolean;
Valeur de propriété
boolean
color
Spécifie la couleur qui est la cible de la condition si le tri est sur la couleur de police ou de cellule.
color?: string;
Valeur de propriété
string
Exemples
/**
* 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
Options de tri supplémentaires pour ce champ.
dataOption?: SortDataOption;
Valeur de propriété
Exemples
/**
* 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
Spécifie l’icône qui est la cible de la condition, si le tri se trouve sur l’icône de la cellule.
icon?: Icon;
Valeur de propriété
key
Spécifie la colonne (ou la ligne, selon l’orientation de tri) sur laquelle la condition se trouve. Représentée sous forme d’un décalage par rapport à la première colonne (ou ligne).
key: number;
Valeur de propriété
number
Exemples
/**
* 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
subField
Spécifie le sous-champ qui est le nom de propriété cible d’une valeur enrichie sur laquelle effectuer le tri.
subField?: string;
Valeur de propriété
string