-
Notifications
You must be signed in to change notification settings - Fork 61
/
excel.interfaces.chartdata.yml
323 lines (323 loc) · 14.7 KB
/
excel.interfaces.chartdata.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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
### YamlMime:TSType
name: Excel.Interfaces.ChartData
uid: 'excel!Excel.Interfaces.ChartData:interface'
package: excel!
fullName: Excel.Interfaces.ChartData
summary: An interface describing the data returned by calling `chart.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: axes
uid: 'excel!Excel.Interfaces.ChartData#axes:member'
package: excel!
fullName: axes
summary: Represents chart axes.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'axes?: Excel.Interfaces.ChartAxesData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartAxesData:interface" />'
- name: categoryLabelLevel
uid: 'excel!Excel.Interfaces.ChartData#categoryLabelLevel:member'
package: excel!
fullName: categoryLabelLevel
summary: 'Specifies a chart category label level enumeration constant, referring to the level of the source category labels.'
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'categoryLabelLevel?: number;'
return:
type: number
- name: chartType
uid: 'excel!Excel.Interfaces.ChartData#chartType:member'
package: excel!
fullName: chartType
summary: Specifies the type of the chart. See `Excel.ChartType` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" |
"3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100"
| "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" |
"LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" |
"XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" |
"AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" |
"Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" |
"StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" |
"CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" |
"CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" |
"ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" |
"PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" |
"3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" |
"Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
return:
type: >-
<xref uid="excel!Excel.ChartType:enum" /> | "Invalid" | "ColumnClustered" | "ColumnStacked" |
"ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" |
"BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" |
"LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded"
| "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" |
"XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" |
"DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" |
"SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" |
"StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" |
"CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" |
"ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" |
"ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" |
"PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie"
| "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap"
| "Treemap" | "Waterfall" | "Sunburst" | "Funnel"
- name: dataLabels
uid: 'excel!Excel.Interfaces.ChartData#dataLabels:member'
package: excel!
fullName: dataLabels
summary: Represents the data labels on the chart.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartDataLabelsData:interface" />'
- name: displayBlanksAs
uid: 'excel!Excel.Interfaces.ChartData#displayBlanksAs:member'
package: excel!
fullName: displayBlanksAs
summary: Specifies the way that blank cells are plotted on a chart.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'displayBlanksAs?: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";'
return:
type: '<xref uid="excel!Excel.ChartDisplayBlanksAs:enum" /> | "NotPlotted" | "Zero" | "Interplotted"'
- name: format
uid: 'excel!Excel.Interfaces.ChartData#format:member'
package: excel!
fullName: format
summary: Encapsulates the format properties for the chart area.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'format?: Excel.Interfaces.ChartAreaFormatData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartAreaFormatData:interface" />'
- name: height
uid: 'excel!Excel.Interfaces.ChartData#height:member'
package: excel!
fullName: height
summary: 'Specifies the height, in points, of the chart object.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'height?: number;'
return:
type: number
- name: id
uid: 'excel!Excel.Interfaces.ChartData#id:member'
package: excel!
fullName: id
summary: The unique ID of chart.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: string;'
return:
type: string
- name: left
uid: 'excel!Excel.Interfaces.ChartData#left:member'
package: excel!
fullName: left
summary: 'The distance, in points, from the left side of the chart to the worksheet origin.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'left?: number;'
return:
type: number
- name: legend
uid: 'excel!Excel.Interfaces.ChartData#legend:member'
package: excel!
fullName: legend
summary: Represents the legend for the chart.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'legend?: Excel.Interfaces.ChartLegendData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartLegendData:interface" />'
- name: name
uid: 'excel!Excel.Interfaces.ChartData#name:member'
package: excel!
fullName: name
summary: Specifies the name of a chart object.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: string;'
return:
type: string
- name: pivotOptions
uid: 'excel!Excel.Interfaces.ChartData#pivotOptions:member'
package: excel!
fullName: pivotOptions
summary: Encapsulates the options for a pivot chart.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'pivotOptions?: Excel.Interfaces.ChartPivotOptionsData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartPivotOptionsData:interface" />'
- name: plotArea
uid: 'excel!Excel.Interfaces.ChartData#plotArea:member'
package: excel!
fullName: plotArea
summary: Represents the plot area for the chart.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'plotArea?: Excel.Interfaces.ChartPlotAreaData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartPlotAreaData:interface" />'
- name: plotBy
uid: 'excel!Excel.Interfaces.ChartData#plotBy:member'
package: excel!
fullName: plotBy
summary: Specifies the way columns or rows are used as data series on the chart.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'plotBy?: Excel.ChartPlotBy | "Rows" | "Columns";'
return:
type: '<xref uid="excel!Excel.ChartPlotBy:enum" /> | "Rows" | "Columns"'
- name: plotVisibleOnly
uid: 'excel!Excel.Interfaces.ChartData#plotVisibleOnly:member'
package: excel!
fullName: plotVisibleOnly
summary: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'plotVisibleOnly?: boolean;'
return:
type: boolean
- name: series
uid: 'excel!Excel.Interfaces.ChartData#series:member'
package: excel!
fullName: series
summary: Represents either a single series or collection of series in the chart.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'series?: Excel.Interfaces.ChartSeriesData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartSeriesData:interface" />[]'
- name: seriesNameLevel
uid: 'excel!Excel.Interfaces.ChartData#seriesNameLevel:member'
package: excel!
fullName: seriesNameLevel
summary: 'Specifies a chart series name level enumeration constant, referring to the level of the source series names.'
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'seriesNameLevel?: number;'
return:
type: number
- name: showAllFieldButtons
uid: 'excel!Excel.Interfaces.ChartData#showAllFieldButtons:member'
package: excel!
fullName: showAllFieldButtons
summary: Specifies whether to display all field buttons on a PivotChart.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showAllFieldButtons?: boolean;'
return:
type: boolean
- name: showDataLabelsOverMaximum
uid: 'excel!Excel.Interfaces.ChartData#showDataLabelsOverMaximum:member'
package: excel!
fullName: showDataLabelsOverMaximum
summary: >-
Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If
the value axis becomes smaller than the size of the data points, you can use this property to set whether to show
the data labels. This property applies to 2-D charts only.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showDataLabelsOverMaximum?: boolean;'
return:
type: boolean
- name: style
uid: 'excel!Excel.Interfaces.ChartData#style:member'
package: excel!
fullName: style
summary: Specifies the chart style for the chart.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'style?: number;'
return:
type: number
- name: title
uid: 'excel!Excel.Interfaces.ChartData#title:member'
package: excel!
fullName: title
summary: >-
Represents the title of the specified chart, including the text, visibility, position, and formatting of the
title.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'title?: Excel.Interfaces.ChartTitleData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartTitleData:interface" />'
- name: top
uid: 'excel!Excel.Interfaces.ChartData#top:member'
package: excel!
fullName: top
summary: >-
Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top
of the chart area (on a chart).
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'top?: number;'
return:
type: number
- name: width
uid: 'excel!Excel.Interfaces.ChartData#width:member'
package: excel!
fullName: width
summary: 'Specifies the width, in points, of the chart object.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'width?: number;'
return:
type: number