-
Notifications
You must be signed in to change notification settings - Fork 65
/
excel.removeduplicatesresult.yml
161 lines (151 loc) · 6.11 KB
/
excel.removeduplicatesresult.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
### YamlMime:TSType
name: Excel.RemoveDuplicatesResult
uid: 'excel!Excel.RemoveDuplicatesResult:class'
package: excel!
fullName: Excel.RemoveDuplicatesResult
summary: Represents the results from `Range.removeDuplicates`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.RemoveDuplicatesResult#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: removed
uid: 'excel!Excel.RemoveDuplicatesResult#removed:member'
package: excel!
fullName: removed
summary: Number of duplicated rows removed by the operation.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly removed: number;'
return:
type: number
- name: uniqueRemaining
uid: 'excel!Excel.RemoveDuplicatesResult#uniqueRemaining:member'
package: excel!
fullName: uniqueRemaining
summary: Number of remaining unique rows present in the resulting range.
remarks: >-
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:D11");
const deleteResult = range.removeDuplicates([0],true);
deleteResult.load();
await context.sync();
console.log(deleteResult.removed + " entries with duplicate names removed.");
console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly uniqueRemaining: number;'
return:
type: number
methods:
- name: load(options)
uid: 'excel!Excel.RemoveDuplicatesResult#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.RemoveDuplicatesResultLoadOptions): Excel.RemoveDuplicatesResult;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.RemoveDuplicatesResultLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.RemoveDuplicatesResult:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.RemoveDuplicatesResult#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.RemoveDuplicatesResult;'
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.RemoveDuplicatesResult:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.RemoveDuplicatesResult#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.RemoveDuplicatesResult;
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.RemoveDuplicatesResult:class" />'
description: ''
- name: toJSON()
uid: 'excel!Excel.RemoveDuplicatesResult#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.RemoveDuplicatesResult` object is an API object, the `toJSON` method
returns a plain JavaScript object (typed as `Excel.Interfaces.RemoveDuplicatesResultData`<!-- -->) that contains
shallow copies of any loaded child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.RemoveDuplicatesResultData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RemoveDuplicatesResultData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'