Skip to content

Commit 354368c

Browse files
authored
Regenerating for API Extractor event support (#937)
1 parent a043cd6 commit 354368c

File tree

175 files changed

+13067
-12972
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

175 files changed

+13067
-12972
lines changed

docs/docs-ref-autogen/excel/excel/excel.binding.yml

+63-62
Original file line numberDiff line numberDiff line change
@@ -41,68 +41,6 @@ properties:
4141
content: 'readonly id: string;'
4242
return:
4343
type: string
44-
- name: onDataChanged
45-
uid: 'excel!Excel.Binding#onDataChanged:member'
46-
package: excel!
47-
fullName: onDataChanged
48-
summary: |-
49-
Occurs when data or formatting within the binding is changed.
50-
51-
\[ [API set: ExcelApi 1.2](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
52-
remarks: ''
53-
isPreview: false
54-
isDeprecated: false
55-
syntax:
56-
content: 'readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;'
57-
return:
58-
type: >-
59-
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
60-
uid="excel!Excel.BindingDataChangedEventArgs:interface" />&gt;
61-
description: >-
62-
63-
64-
#### Examples
65-
66-
67-
```typescript
68-
69-
// Link to full sample:
70-
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml
71-
72-
await Excel.run(async (context) => {
73-
const sheet = context.workbook.worksheets.getItem("Sample");
74-
const salesTable = sheet.tables.getItem("SalesTable");
75-
const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
76-
salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);
77-
78-
console.log("The data changed handler is registered.");
79-
80-
await context.sync();
81-
});
82-
83-
```
84-
- name: onSelectionChanged
85-
uid: 'excel!Excel.Binding#onSelectionChanged:member'
86-
package: excel!
87-
fullName: onSelectionChanged
88-
summary: >-
89-
Occurs when the selected content in the binding is changed.
90-
91-
92-
*Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column
93-
information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges.
94-
95-
96-
\[ [API set: ExcelApi 1.2](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
97-
remarks: ''
98-
isPreview: false
99-
isDeprecated: false
100-
syntax:
101-
content: 'readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;'
102-
return:
103-
type: >-
104-
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
105-
uid="excel!Excel.BindingSelectionChangedEventArgs:interface" />&gt;
10644
- name: type
10745
uid: 'excel!Excel.Binding#type:member'
10846
package: excel!
@@ -343,4 +281,67 @@ methods:
343281
return:
344282
type: '<xref uid="excel!Excel.Interfaces.BindingData:interface" />'
345283
description: ''
284+
events:
285+
- name: onDataChanged
286+
uid: 'excel!Excel.Binding#onDataChanged:member'
287+
package: excel!
288+
fullName: onDataChanged
289+
summary: |-
290+
Occurs when data or formatting within the binding is changed.
291+
292+
\[ [API set: ExcelApi 1.2](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
293+
remarks: ''
294+
isPreview: false
295+
isDeprecated: false
296+
syntax:
297+
content: 'readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;'
298+
return:
299+
type: >-
300+
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
301+
uid="excel!Excel.BindingDataChangedEventArgs:interface" />&gt;
302+
description: >-
303+
304+
305+
#### Examples
306+
307+
308+
```typescript
309+
310+
// Link to full sample:
311+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-changed.yaml
312+
313+
await Excel.run(async (context) => {
314+
const sheet = context.workbook.worksheets.getItem("Sample");
315+
const salesTable = sheet.tables.getItem("SalesTable");
316+
const salesByQuarterBinding = context.workbook.bindings.add(salesTable.getRange(), "Table", "SalesByQuarter");
317+
salesByQuarterBinding.onDataChanged.add(onSalesDataChanged);
318+
319+
console.log("The data changed handler is registered.");
320+
321+
await context.sync();
322+
});
323+
324+
```
325+
- name: onSelectionChanged
326+
uid: 'excel!Excel.Binding#onSelectionChanged:member'
327+
package: excel!
328+
fullName: onSelectionChanged
329+
summary: >-
330+
Occurs when the selected content in the binding is changed.
331+
332+
333+
*Note**: If multiple, discontiguous cells are selected, `Binding.onSelectionChanged` only reports row and column
334+
information for one selection. Use `Worksheet.onSelectionChanged` for multiple selected ranges.
335+
336+
337+
\[ [API set: ExcelApi 1.2](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
338+
remarks: ''
339+
isPreview: false
340+
isDeprecated: false
341+
syntax:
342+
content: 'readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;'
343+
return:
344+
type: >-
345+
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
346+
uid="excel!Excel.BindingSelectionChangedEventArgs:interface" />&gt;
346347
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'

docs/docs-ref-autogen/excel/excel/excel.chart.yml

+69-68
Original file line numberDiff line numberDiff line change
@@ -267,74 +267,6 @@ properties:
267267
}
268268
});
269269
```
270-
- name: onActivated
271-
uid: 'excel!Excel.Chart#onActivated:member'
272-
package: excel!
273-
fullName: onActivated
274-
summary: |-
275-
Occurs when the chart is activated.
276-
277-
\[ [API set: ExcelApi 1.8](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
278-
remarks: ''
279-
isPreview: false
280-
isDeprecated: false
281-
syntax:
282-
content: 'readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;'
283-
return:
284-
type: >-
285-
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
286-
uid="excel!Excel.ChartActivatedEventArgs:interface" />&gt;
287-
description: |-
288-
289-
290-
#### Examples
291-
292-
```javascript
293-
Excel.run(function (context){
294-
var pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
295-
pieChart.onActivated.add(function (event) {
296-
return Excel.run(function (context) {
297-
console.log("The pie chart is the active chart. ID: " + event.chartId);
298-
return context.sync();
299-
});
300-
});
301-
return context.sync();
302-
});
303-
```
304-
- name: onDeactivated
305-
uid: 'excel!Excel.Chart#onDeactivated:member'
306-
package: excel!
307-
fullName: onDeactivated
308-
summary: |-
309-
Occurs when the chart is deactivated.
310-
311-
\[ [API set: ExcelApi 1.8](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
312-
remarks: ''
313-
isPreview: false
314-
isDeprecated: false
315-
syntax:
316-
content: 'readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;'
317-
return:
318-
type: >-
319-
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
320-
uid="excel!Excel.ChartDeactivatedEventArgs:interface" />&gt;
321-
description: |-
322-
323-
324-
#### Examples
325-
326-
```javascript
327-
Excel.run(function (context){
328-
var pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
329-
pieChart.onDeactivated.add(function (event) {
330-
return Excel.run(function (context) {
331-
console.log("The pie chart is NOT active.");
332-
return context.sync();
333-
});
334-
});
335-
return context.sync();
336-
});
337-
```
338270
- name: pivotOptions
339271
uid: 'excel!Excel.Chart#pivotOptions:member'
340272
package: excel!
@@ -931,4 +863,73 @@ methods:
931863
return:
932864
type: '<xref uid="excel!Excel.Interfaces.ChartData:interface" />'
933865
description: ''
866+
events:
867+
- name: onActivated
868+
uid: 'excel!Excel.Chart#onActivated:member'
869+
package: excel!
870+
fullName: onActivated
871+
summary: |-
872+
Occurs when the chart is activated.
873+
874+
\[ [API set: ExcelApi 1.8](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
875+
remarks: ''
876+
isPreview: false
877+
isDeprecated: false
878+
syntax:
879+
content: 'readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;'
880+
return:
881+
type: >-
882+
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
883+
uid="excel!Excel.ChartActivatedEventArgs:interface" />&gt;
884+
description: |-
885+
886+
887+
#### Examples
888+
889+
```javascript
890+
Excel.run(function (context){
891+
var pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
892+
pieChart.onActivated.add(function (event) {
893+
return Excel.run(function (context) {
894+
console.log("The pie chart is the active chart. ID: " + event.chartId);
895+
return context.sync();
896+
});
897+
});
898+
return context.sync();
899+
});
900+
```
901+
- name: onDeactivated
902+
uid: 'excel!Excel.Chart#onDeactivated:member'
903+
package: excel!
904+
fullName: onDeactivated
905+
summary: |-
906+
Occurs when the chart is deactivated.
907+
908+
\[ [API set: ExcelApi 1.8](/office/dev/add-ins/reference/requirement-sets/excel-api-requirement-sets) \]
909+
remarks: ''
910+
isPreview: false
911+
isDeprecated: false
912+
syntax:
913+
content: 'readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;'
914+
return:
915+
type: >-
916+
<xref uid="office!OfficeExtension.EventHandlers:class" />&lt;<xref
917+
uid="excel!Excel.ChartDeactivatedEventArgs:interface" />&gt;
918+
description: |-
919+
920+
921+
#### Examples
922+
923+
```javascript
924+
Excel.run(function (context){
925+
var pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");
926+
pieChart.onDeactivated.add(function (event) {
927+
return Excel.run(function (context) {
928+
console.log("The pie chart is NOT active.");
929+
return context.sync();
930+
});
931+
});
932+
return context.sync();
933+
});
934+
```
934935
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'

0 commit comments

Comments
 (0)