Excel.TableSort class
管理对象的 Table 排序操作。
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| fields | 指定用于最后对表排序的当前条件。 |
| match |
指定大小写是否影响表格的最后一种排序。 |
| method | 表示上次用于对表进行排序的中文字符排序方法。 |
方法
| apply(fields, match |
执行排序操作。 |
| apply(fields, match |
执行排序操作。 |
| clear() | 清除表上的当前排序。 尽管这不能修改表的排序，但它会清除标题按钮的状态。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| reapply() | 对 table 重新应用当前的排序参数。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
fields
matchCase
method
表示上次用于对表进行排序的中文字符排序方法。
readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";属性值
Excel.SortMethod | "PinYin" | "StrokeCount"
注解
方法详细信息
apply(fields, matchCase, method)
执行排序操作。
apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;参数
- fields
要用作排序依据的条件列表。
- matchCase
-
boolean
可选。 是否让大小写对字符串排序产生影响。
- method
- Excel.SortMethod
可选。 用于中文字符的排序方法。
返回
void
注解
示例
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.sort.apply([
{
key: 2,
ascending: true
},
], true);
await context.sync();
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/sort-data.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");
// Sort the table by the "Amount" column.
const sortFields = [
{
key: 3,
ascending: false
}
];
expensesTable.sort.apply(sortFields);
await context.sync();
});
apply(fields, matchCase, method)
执行排序操作。
apply(fields: Excel.SortField[], matchCase?: boolean, method?: "PinYin" | "StrokeCount"): void;参数
- fields
要用作排序依据的条件列表。
- matchCase
-
boolean
可选。 是否让大小写对字符串排序产生影响。
- method
-
"PinYin" | "StrokeCount"
可选。 用于中文字符的排序方法。
返回
void
注解
clear()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.TableSort;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableSort;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
reapply()
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.TableSort 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.TableSortData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.TableSortData;