-
Notifications
You must be signed in to change notification settings - Fork 63
/
excel.interfaces.chartaxisupdatedata.yml
409 lines (409 loc) · 17.8 KB
/
excel.interfaces.chartaxisupdatedata.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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
### YamlMime:TSType
name: Excel.Interfaces.ChartAxisUpdateData
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData:interface'
package: excel!
fullName: Excel.Interfaces.ChartAxisUpdateData
summary: 'An interface for updating data on the ChartAxis object, for use in `chartAxis.set({ ... })`<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: alignment
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#alignment:member'
package: excel!
fullName: alignment
summary: Specifies the alignment for the specified axis tick label. See `Excel.ChartTextHorizontalAlignment` for detail.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'alignment?: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";'
return:
type: '<xref uid="excel!Excel.ChartTickLabelAlignment:enum" /> | "Center" | "Left" | "Right"'
- name: baseTimeUnit
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#baseTimeUnit:member'
package: excel!
fullName: baseTimeUnit
summary: Specifies the base unit for the specified category axis.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'baseTimeUnit?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";'
return:
type: '<xref uid="excel!Excel.ChartAxisTimeUnit:enum" /> | "Days" | "Months" | "Years"'
- name: categoryType
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#categoryType:member'
package: excel!
fullName: categoryType
summary: Specifies the category axis type.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'categoryType?: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";'
return:
type: '<xref uid="excel!Excel.ChartAxisCategoryType:enum" /> | "Automatic" | "TextAxis" | "DateAxis"'
- name: displayUnit
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#displayUnit:member'
package: excel!
fullName: displayUnit
summary: Represents the axis display unit. See `Excel.ChartAxisDisplayUnit` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
displayUnit?: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" |
"HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";
return:
type: >-
<xref uid="excel!Excel.ChartAxisDisplayUnit:enum" /> | "None" | "Hundreds" | "Thousands" | "TenThousands" |
"HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"
- name: format
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#format:member'
package: excel!
fullName: format
summary: 'Represents the formatting of a chart object, which includes line and font formatting.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'format?: Excel.Interfaces.ChartAxisFormatUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartAxisFormatUpdateData:interface" />'
- name: isBetweenCategories
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#isBetweenCategories:member'
package: excel!
fullName: isBetweenCategories
summary: Specifies if the value axis crosses the category axis between categories.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isBetweenCategories?: boolean;'
return:
type: boolean
- name: linkNumberFormat
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#linkNumberFormat:member'
package: excel!
fullName: linkNumberFormat
summary: >-
Specifies if the number format is linked to the cells. If `true`<!-- -->, the number format will change in the
labels when it changes in the cells.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'linkNumberFormat?: boolean;'
return:
type: boolean
- name: logBase
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#logBase:member'
package: excel!
fullName: logBase
summary: Specifies the base of the logarithm when using logarithmic scales.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'logBase?: number;'
return:
type: number
- name: majorGridlines
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#majorGridlines:member'
package: excel!
fullName: majorGridlines
summary: Returns an object that represents the major gridlines for the specified axis.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'majorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartGridlinesUpdateData:interface" />'
- name: majorTickMark
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#majorTickMark:member'
package: excel!
fullName: majorTickMark
summary: Specifies the type of major tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'majorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";'
return:
type: '<xref uid="excel!Excel.ChartAxisTickMark:enum" /> | "None" | "Cross" | "Inside" | "Outside"'
- name: majorTimeUnitScale
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#majorTimeUnitScale:member'
package: excel!
fullName: majorTimeUnitScale
summary: >-
Specifies the major unit scale value for the category axis when the `categoryType` property is set to
`dateAxis`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'majorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";'
return:
type: '<xref uid="excel!Excel.ChartAxisTimeUnit:enum" /> | "Days" | "Months" | "Years"'
- name: majorUnit
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#majorUnit:member'
package: excel!
fullName: majorUnit
summary: >-
Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The
returned value is always a number.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'majorUnit?: any;'
return:
type: any
- name: maximum
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#maximum:member'
package: excel!
fullName: maximum
summary: >-
Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic
axis values). The returned value is always a number.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'maximum?: any;'
return:
type: any
- name: minimum
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#minimum:member'
package: excel!
fullName: minimum
summary: >-
Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic
axis values). The returned value is always a number.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'minimum?: any;'
return:
type: any
- name: minorGridlines
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#minorGridlines:member'
package: excel!
fullName: minorGridlines
summary: Returns an object that represents the minor gridlines for the specified axis.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'minorGridlines?: Excel.Interfaces.ChartGridlinesUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartGridlinesUpdateData:interface" />'
- name: minorTickMark
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#minorTickMark:member'
package: excel!
fullName: minorTickMark
summary: Specifies the type of minor tick mark for the specified axis. See `Excel.ChartAxisTickMark` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'minorTickMark?: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";'
return:
type: '<xref uid="excel!Excel.ChartAxisTickMark:enum" /> | "None" | "Cross" | "Inside" | "Outside"'
- name: minorTimeUnitScale
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#minorTimeUnitScale:member'
package: excel!
fullName: minorTimeUnitScale
summary: >-
Specifies the minor unit scale value for the category axis when the `categoryType` property is set to
`dateAxis`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'minorTimeUnitScale?: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";'
return:
type: '<xref uid="excel!Excel.ChartAxisTimeUnit:enum" /> | "Days" | "Months" | "Years"'
- name: minorUnit
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#minorUnit:member'
package: excel!
fullName: minorUnit
summary: >-
Represents the interval between two minor tick marks. Can be set to a numeric value or an empty string (for
automatic axis values). The returned value is always a number.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'minorUnit?: any;'
return:
type: any
- name: multiLevel
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#multiLevel:member'
package: excel!
fullName: multiLevel
summary: Specifies if an axis is multilevel.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'multiLevel?: boolean;'
return:
type: boolean
- name: numberFormat
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#numberFormat:member'
package: excel!
fullName: numberFormat
summary: Specifies the format code for the axis tick label.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormat?: string;'
return:
type: string
- name: offset
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#offset:member'
package: excel!
fullName: offset
summary: >-
Specifies the distance between the levels of labels, and the distance between the first level and the axis line.
The value should be an integer from 0 to 1000.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'offset?: number;'
return:
type: number
- name: position
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#position:member'
package: excel!
fullName: position
summary: Specifies the specified axis position where the other axis crosses. See `Excel.ChartAxisPosition` for details.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'position?: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";'
return:
type: '<xref uid="excel!Excel.ChartAxisPosition:enum" /> | "Automatic" | "Maximum" | "Minimum" | "Custom"'
- name: reversePlotOrder
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#reversePlotOrder:member'
package: excel!
fullName: reversePlotOrder
summary: Specifies if Excel plots data points from last to first.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'reversePlotOrder?: boolean;'
return:
type: boolean
- name: scaleType
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#scaleType:member'
package: excel!
fullName: scaleType
summary: Specifies the value axis scale type. See `Excel.ChartAxisScaleType` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'scaleType?: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";'
return:
type: '<xref uid="excel!Excel.ChartAxisScaleType:enum" /> | "Linear" | "Logarithmic"'
- name: showDisplayUnitLabel
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#showDisplayUnitLabel:member'
package: excel!
fullName: showDisplayUnitLabel
summary: Specifies if the axis display unit label is visible.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showDisplayUnitLabel?: boolean;'
return:
type: boolean
- name: textOrientation
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#textOrientation:member'
package: excel!
fullName: textOrientation
summary: >-
Specifies the angle to which the text is oriented for the chart axis tick label. The value should either be an
integer from -90 to 90 or the integer 180 for vertically-oriented text.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'textOrientation?: any;'
return:
type: any
- name: tickLabelPosition
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#tickLabelPosition:member'
package: excel!
fullName: tickLabelPosition
summary: >-
Specifies the position of tick-mark labels on the specified axis. See `Excel.ChartAxisTickLabelPosition` for
details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tickLabelPosition?: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";'
return:
type: '<xref uid="excel!Excel.ChartAxisTickLabelPosition:enum" /> | "NextToAxis" | "High" | "Low" | "None"'
- name: tickLabelSpacing
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#tickLabelSpacing:member'
package: excel!
fullName: tickLabelSpacing
summary: >-
Specifies the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an
empty string for automatic setting. The returned value is always a number.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tickLabelSpacing?: any;'
return:
type: any
- name: tickMarkSpacing
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#tickMarkSpacing:member'
package: excel!
fullName: tickMarkSpacing
summary: Specifies the number of categories or series between tick marks.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tickMarkSpacing?: number;'
return:
type: number
- name: title
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#title:member'
package: excel!
fullName: title
summary: Represents the axis 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.ChartAxisTitleUpdateData;'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartAxisTitleUpdateData:interface" />'
- name: visible
uid: 'excel!Excel.Interfaces.ChartAxisUpdateData#visible:member'
package: excel!
fullName: visible
summary: Specifies if the axis is visible.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'visible?: boolean;'
return:
type: boolean