-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.tablesort.yml
239 lines (237 loc) · 8.99 KB
/
excel.tablesort.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
### YamlMime:TSType
name: Excel.TableSort
uid: 'excel!Excel.TableSort:class'
package: excel!
fullName: Excel.TableSort
summary: Manages sorting operations on `Table` objects.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.TableSort#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: fields
uid: 'excel!Excel.TableSort#fields:member'
package: excel!
fullName: fields
summary: Specifies the current conditions used to last sort the table.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly fields: Excel.SortField[];'
return:
type: '<xref uid="excel!Excel.SortField:interface" />[]'
- name: matchCase
uid: 'excel!Excel.TableSort#matchCase:member'
package: excel!
fullName: matchCase
summary: Specifies if the casing impacts the last sort of the table.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly matchCase: boolean;'
return:
type: boolean
- name: method
uid: 'excel!Excel.TableSort#method:member'
package: excel!
fullName: method
summary: Represents the Chinese character ordering method last used to sort the table.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly method: Excel.SortMethod | "PinYin" | "StrokeCount";'
return:
type: '<xref uid="excel!Excel.SortMethod:enum" /> | "PinYin" | "StrokeCount"'
methods:
- name: 'apply(fields, matchCase, method)'
uid: 'excel!Excel.TableSort#apply:member(1)'
package: excel!
fullName: 'apply(fields, matchCase, method)'
summary: Perform a sort operation.
remarks: |-
\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
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();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod): void;'
parameters:
- id: fields
description: The list of conditions to sort on.
type: '<xref uid="excel!Excel.SortField:interface" />[]'
- id: matchCase
description: Optional. Whether to have the casing impact string ordering.
type: boolean
- id: method
description: Optional. The ordering method used for Chinese characters.
type: '<xref uid="excel!Excel.SortMethod:enum" />'
return:
type: void
description: ''
- name: 'apply(fields, matchCase, methodString)'
uid: 'excel!Excel.TableSort#apply:member(2)'
package: excel!
fullName: 'apply(fields, matchCase, methodString)'
summary: Perform a sort operation.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'apply(fields: Excel.SortField[], matchCase?: boolean, methodString?: "PinYin" | "StrokeCount"): void;'
parameters:
- id: fields
description: The list of conditions to sort on.
type: '<xref uid="excel!Excel.SortField:interface" />[]'
- id: matchCase
description: Optional. Whether to have the casing impact string ordering.
type: boolean
- id: methodString
description: Optional. The ordering method used for Chinese characters.
type: '"PinYin" | "StrokeCount"'
return:
type: void
description: ''
- name: clear()
uid: 'excel!Excel.TableSort#clear:member(1)'
package: excel!
fullName: clear()
summary: >-
Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the
state of the header buttons.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'clear(): void;'
return:
type: void
description: ''
- name: load(options)
uid: 'excel!Excel.TableSort#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Excel.Interfaces.TableSortLoadOptions): Excel.TableSort;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.TableSortLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.TableSort:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.TableSort#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.TableSort;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.TableSort:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.TableSort#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableSort;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.TableSort:class" />'
description: ''
- name: reapply()
uid: 'excel!Excel.TableSort#reapply:member(1)'
package: excel!
fullName: reapply()
summary: Reapplies the current sorting parameters to the table.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'reapply(): void;'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.TableSort#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Excel.TableSort object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.TableSortData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.TableSortData;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableSortData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'