-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.chartseriescollection.yml
212 lines (205 loc) · 8.27 KB
/
excel.chartseriescollection.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
### YamlMime:TSType
name: Excel.ChartSeriesCollection
uid: 'excel!Excel.ChartSeriesCollection:class'
package: excel!
fullName: Excel.ChartSeriesCollection
summary: Represents a collection of chart series.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.ChartSeriesCollection#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: count
uid: 'excel!Excel.ChartSeriesCollection#count:member'
package: excel!
fullName: count
summary: Returns the number of series in the collection.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly count: number;'
return:
type: number
- name: items
uid: 'excel!Excel.ChartSeriesCollection#items:member'
package: excel!
fullName: items
summary: Gets the loaded child items in this collection.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'readonly items: Excel.ChartSeries[];'
return:
type: '<xref uid="excel!Excel.ChartSeries:class" />[]'
methods:
- name: 'add(name, index)'
uid: 'excel!Excel.ChartSeriesCollection#add:member(1)'
package: excel!
fullName: 'add(name, index)'
summary: >-
Add a new series to the collection. The new added series is not visible until values, x-axis values, or bubble
sizes for it are set (depending on chart type).
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'add(name?: string, index?: number): Excel.ChartSeries;'
parameters:
- id: name
description: Optional. Name of the series.
type: string
- id: index
description: Optional. Index value of the series to be added. Zero-indexed.
type: number
return:
type: '<xref uid="excel!Excel.ChartSeries:class" />'
description: ''
- name: getCount()
uid: 'excel!Excel.ChartSeriesCollection#getCount:member(1)'
package: excel!
fullName: getCount()
summary: Returns the number of series in the collection.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getCount(): OfficeExtension.ClientResult<number>;'
return:
type: '<xref uid="office!OfficeExtension.ClientResult:class" /><number>'
description: ''
- name: getItemAt(index)
uid: 'excel!Excel.ChartSeriesCollection#getItemAt:member(1)'
package: excel!
fullName: getItemAt(index)
summary: Retrieves a series based on its position in the collection.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Get the name of the first series in the series collection.
await Excel.run(async (context) => {
const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
seriesCollection.load('items');
await context.sync();
console.log(seriesCollection.items[0].name);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getItemAt(index: number): Excel.ChartSeries;'
parameters:
- id: index
description: Index value of the object to be retrieved. Zero-indexed.
type: number
return:
type: '<xref uid="excel!Excel.ChartSeries:class" />'
description: ''
- name: load(options)
uid: 'excel!Excel.ChartSeriesCollection#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.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions):
Excel.ChartSeriesCollection;
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: >-
<xref uid="excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions:interface" /> & <xref
uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
return:
type: '<xref uid="excel!Excel.ChartSeriesCollection:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.ChartSeriesCollection#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.ChartSeriesCollection;'
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.ChartSeriesCollection:class" />'
description: |-
#### Examples
```TypeScript
// Get the number of chart series in the collection.
await Excel.run(async (context) => {
const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
seriesCollection.load('count');
await context.sync();
console.log("series: Count= " + seriesCollection.count);
});
```
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.ChartSeriesCollection#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?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection;'
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: '<xref uid="office!OfficeExtension.LoadOption:interface" />'
return:
type: '<xref uid="excel!Excel.ChartSeriesCollection:class" />'
description: ''
- name: toJSON()
uid: 'excel!Excel.ChartSeriesCollection#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.ChartSeriesCollection` object is an API object, the `toJSON` method
returns a plain JavaScript object (typed as `Excel.Interfaces.ChartSeriesCollectionData`<!-- -->) that contains an
"items" array with shallow copies of any loaded properties from the collection's items.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.ChartSeriesCollectionData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartSeriesCollectionData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'