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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
"""Enumerations used by charts and related objects."""
from __future__ import annotations
from pptx.enum.base import BaseEnum, BaseXmlEnum
class XL_AXIS_CROSSES(BaseXmlEnum):
"""Specifies the point on an axis where the other axis crosses.
Example::
from pptx.enum.chart import XL_AXIS_CROSSES
value_axis.crosses = XL_AXIS_CROSSES.MAXIMUM
MS API Name: `XlAxisCrosses`
https://msdn.microsoft.com/en-us/library/office/ff745402.aspx
"""
AUTOMATIC = (-4105, "autoZero", "The axis crossing point is set automatically, often at zero.")
"""The axis crossing point is set automatically, often at zero."""
CUSTOM = (-4114, "", "The .crosses_at property specifies the axis crossing point.")
"""The .crosses_at property specifies the axis crossing point."""
MAXIMUM = (2, "max", "The axis crosses at the maximum value.")
"""The axis crosses at the maximum value."""
MINIMUM = (4, "min", "The axis crosses at the minimum value.")
"""The axis crosses at the minimum value."""
class XL_CATEGORY_TYPE(BaseEnum):
"""Specifies the type of the category axis.
Example::
from pptx.enum.chart import XL_CATEGORY_TYPE
date_axis = chart.category_axis
assert date_axis.category_type == XL_CATEGORY_TYPE.TIME_SCALE
MS API Name: `XlCategoryType`
https://msdn.microsoft.com/EN-US/library/office/ff746136.aspx
"""
AUTOMATIC_SCALE = (-4105, "The application controls the axis type.")
"""The application controls the axis type."""
CATEGORY_SCALE = (2, "Axis groups data by an arbitrary set of categories")
"""Axis groups data by an arbitrary set of categories"""
TIME_SCALE = (3, "Axis groups data on a time scale of days, months, or years.")
"""Axis groups data on a time scale of days, months, or years."""
class XL_CHART_TYPE(BaseEnum):
"""Specifies the type of a chart.
Example::
from pptx.enum.chart import XL_CHART_TYPE
assert chart.chart_type == XL_CHART_TYPE.BAR_STACKED
MS API Name: `XlChartType`
http://msdn.microsoft.com/en-us/library/office/ff838409.aspx
"""
THREE_D_AREA = (-4098, "3D Area.")
"""3D Area."""
THREE_D_AREA_STACKED = (78, "3D Stacked Area.")
"""3D Stacked Area."""
THREE_D_AREA_STACKED_100 = (79, "100% Stacked Area.")
"""100% Stacked Area."""
THREE_D_BAR_CLUSTERED = (60, "3D Clustered Bar.")
"""3D Clustered Bar."""
THREE_D_BAR_STACKED = (61, "3D Stacked Bar.")
"""3D Stacked Bar."""
THREE_D_BAR_STACKED_100 = (62, "3D 100% Stacked Bar.")
"""3D 100% Stacked Bar."""
THREE_D_COLUMN = (-4100, "3D Column.")
"""3D Column."""
THREE_D_COLUMN_CLUSTERED = (54, "3D Clustered Column.")
"""3D Clustered Column."""
THREE_D_COLUMN_STACKED = (55, "3D Stacked Column.")
"""3D Stacked Column."""
THREE_D_COLUMN_STACKED_100 = (56, "3D 100% Stacked Column.")
"""3D 100% Stacked Column."""
THREE_D_LINE = (-4101, "3D Line.")
"""3D Line."""
THREE_D_PIE = (-4102, "3D Pie.")
"""3D Pie."""
THREE_D_PIE_EXPLODED = (70, "Exploded 3D Pie.")
"""Exploded 3D Pie."""
AREA = (1, "Area")
"""Area"""
AREA_STACKED = (76, "Stacked Area.")
"""Stacked Area."""
AREA_STACKED_100 = (77, "100% Stacked Area.")
"""100% Stacked Area."""
BAR_CLUSTERED = (57, "Clustered Bar.")
"""Clustered Bar."""
BAR_OF_PIE = (71, "Bar of Pie.")
"""Bar of Pie."""
BAR_STACKED = (58, "Stacked Bar.")
"""Stacked Bar."""
BAR_STACKED_100 = (59, "100% Stacked Bar.")
"""100% Stacked Bar."""
BUBBLE = (15, "Bubble.")
"""Bubble."""
BUBBLE_THREE_D_EFFECT = (87, "Bubble with 3D effects.")
"""Bubble with 3D effects."""
COLUMN_CLUSTERED = (51, "Clustered Column.")
"""Clustered Column."""
COLUMN_STACKED = (52, "Stacked Column.")
"""Stacked Column."""
COLUMN_STACKED_100 = (53, "100% Stacked Column.")
"""100% Stacked Column."""
CONE_BAR_CLUSTERED = (102, "Clustered Cone Bar.")
"""Clustered Cone Bar."""
CONE_BAR_STACKED = (103, "Stacked Cone Bar.")
"""Stacked Cone Bar."""
CONE_BAR_STACKED_100 = (104, "100% Stacked Cone Bar.")
"""100% Stacked Cone Bar."""
CONE_COL = (105, "3D Cone Column.")
"""3D Cone Column."""
CONE_COL_CLUSTERED = (99, "Clustered Cone Column.")
"""Clustered Cone Column."""
CONE_COL_STACKED = (100, "Stacked Cone Column.")
"""Stacked Cone Column."""
CONE_COL_STACKED_100 = (101, "100% Stacked Cone Column.")
"""100% Stacked Cone Column."""
CYLINDER_BAR_CLUSTERED = (95, "Clustered Cylinder Bar.")
"""Clustered Cylinder Bar."""
CYLINDER_BAR_STACKED = (96, "Stacked Cylinder Bar.")
"""Stacked Cylinder Bar."""
CYLINDER_BAR_STACKED_100 = (97, "100% Stacked Cylinder Bar.")
"""100% Stacked Cylinder Bar."""
CYLINDER_COL = (98, "3D Cylinder Column.")
"""3D Cylinder Column."""
CYLINDER_COL_CLUSTERED = (92, "Clustered Cone Column.")
"""Clustered Cone Column."""
CYLINDER_COL_STACKED = (93, "Stacked Cone Column.")
"""Stacked Cone Column."""
CYLINDER_COL_STACKED_100 = (94, "100% Stacked Cylinder Column.")
"""100% Stacked Cylinder Column."""
DOUGHNUT = (-4120, "Doughnut.")
"""Doughnut."""
DOUGHNUT_EXPLODED = (80, "Exploded Doughnut.")
"""Exploded Doughnut."""
LINE = (4, "Line.")
"""Line."""
LINE_MARKERS = (65, "Line with Markers.")
"""Line with Markers."""
LINE_MARKERS_STACKED = (66, "Stacked Line with Markers.")
"""Stacked Line with Markers."""
LINE_MARKERS_STACKED_100 = (67, "100% Stacked Line with Markers.")
"""100% Stacked Line with Markers."""
LINE_STACKED = (63, "Stacked Line.")
"""Stacked Line."""
LINE_STACKED_100 = (64, "100% Stacked Line.")
"""100% Stacked Line."""
PIE = (5, "Pie.")
"""Pie."""
PIE_EXPLODED = (69, "Exploded Pie.")
"""Exploded Pie."""
PIE_OF_PIE = (68, "Pie of Pie.")
"""Pie of Pie."""
PYRAMID_BAR_CLUSTERED = (109, "Clustered Pyramid Bar.")
"""Clustered Pyramid Bar."""
PYRAMID_BAR_STACKED = (110, "Stacked Pyramid Bar.")
"""Stacked Pyramid Bar."""
PYRAMID_BAR_STACKED_100 = (111, "100% Stacked Pyramid Bar.")
"""100% Stacked Pyramid Bar."""
PYRAMID_COL = (112, "3D Pyramid Column.")
"""3D Pyramid Column."""
PYRAMID_COL_CLUSTERED = (106, "Clustered Pyramid Column.")
"""Clustered Pyramid Column."""
PYRAMID_COL_STACKED = (107, "Stacked Pyramid Column.")
"""Stacked Pyramid Column."""
PYRAMID_COL_STACKED_100 = (108, "100% Stacked Pyramid Column.")
"""100% Stacked Pyramid Column."""
RADAR = (-4151, "Radar.")
"""Radar."""
RADAR_FILLED = (82, "Filled Radar.")
"""Filled Radar."""
RADAR_MARKERS = (81, "Radar with Data Markers.")
"""Radar with Data Markers."""
STOCK_HLC = (88, "High-Low-Close.")
"""High-Low-Close."""
STOCK_OHLC = (89, "Open-High-Low-Close.")
"""Open-High-Low-Close."""
STOCK_VHLC = (90, "Volume-High-Low-Close.")
"""Volume-High-Low-Close."""
STOCK_VOHLC = (91, "Volume-Open-High-Low-Close.")
"""Volume-Open-High-Low-Close."""
SURFACE = (83, "3D Surface.")
"""3D Surface."""
SURFACE_TOP_VIEW = (85, "Surface (Top View).")
"""Surface (Top View)."""
SURFACE_TOP_VIEW_WIREFRAME = (86, "Surface (Top View wireframe).")
"""Surface (Top View wireframe)."""
SURFACE_WIREFRAME = (84, "3D Surface (wireframe).")
"""3D Surface (wireframe)."""
XY_SCATTER = (-4169, "Scatter.")
"""Scatter."""
XY_SCATTER_LINES = (74, "Scatter with Lines.")
"""Scatter with Lines."""
XY_SCATTER_LINES_NO_MARKERS = (75, "Scatter with Lines and No Data Markers.")
"""Scatter with Lines and No Data Markers."""
XY_SCATTER_SMOOTH = (72, "Scatter with Smoothed Lines.")
"""Scatter with Smoothed Lines."""
XY_SCATTER_SMOOTH_NO_MARKERS = (73, "Scatter with Smoothed Lines and No Data Markers.")
"""Scatter with Smoothed Lines and No Data Markers."""
class XL_DATA_LABEL_POSITION(BaseXmlEnum):
"""Specifies where the data label is positioned.
Example::
from pptx.enum.chart import XL_LABEL_POSITION
data_labels = chart.plots[0].data_labels
data_labels.position = XL_LABEL_POSITION.OUTSIDE_END
MS API Name: `XlDataLabelPosition`
http://msdn.microsoft.com/en-us/library/office/ff745082.aspx
"""
ABOVE = (0, "t", "The data label is positioned above the data point.")
"""The data label is positioned above the data point."""
BELOW = (1, "b", "The data label is positioned below the data point.")
"""The data label is positioned below the data point."""
BEST_FIT = (5, "bestFit", "Word sets the position of the data label.")
"""Word sets the position of the data label."""
CENTER = (
-4108,
"ctr",
"The data label is centered on the data point or inside a bar or a pie slice.",
)
"""The data label is centered on the data point or inside a bar or a pie slice."""
INSIDE_BASE = (
4,
"inBase",
"The data label is positioned inside the data point at the bottom edge.",
)
"""The data label is positioned inside the data point at the bottom edge."""
INSIDE_END = (3, "inEnd", "The data label is positioned inside the data point at the top edge.")
"""The data label is positioned inside the data point at the top edge."""
LEFT = (-4131, "l", "The data label is positioned to the left of the data point.")
"""The data label is positioned to the left of the data point."""
MIXED = (6, "", "Data labels are in multiple positions (read-only).")
"""Data labels are in multiple positions (read-only)."""
OUTSIDE_END = (
2,
"outEnd",
"The data label is positioned outside the data point at the top edge.",
)
"""The data label is positioned outside the data point at the top edge."""
RIGHT = (-4152, "r", "The data label is positioned to the right of the data point.")
"""The data label is positioned to the right of the data point."""
XL_LABEL_POSITION = XL_DATA_LABEL_POSITION
class XL_LEGEND_POSITION(BaseXmlEnum):
"""Specifies the position of the legend on a chart.
Example::
from pptx.enum.chart import XL_LEGEND_POSITION
chart.has_legend = True
chart.legend.position = XL_LEGEND_POSITION.BOTTOM
MS API Name: `XlLegendPosition`
http://msdn.microsoft.com/en-us/library/office/ff745840.aspx
"""
BOTTOM = (-4107, "b", "Below the chart.")
"""Below the chart."""
CORNER = (2, "tr", "In the upper-right corner of the chart border.")
"""In the upper-right corner of the chart border."""
CUSTOM = (-4161, "", "A custom position (read-only).")
"""A custom position (read-only)."""
LEFT = (-4131, "l", "Left of the chart.")
"""Left of the chart."""
RIGHT = (-4152, "r", "Right of the chart.")
"""Right of the chart."""
TOP = (-4160, "t", "Above the chart.")
"""Above the chart."""
class XL_MARKER_STYLE(BaseXmlEnum):
"""Specifies the marker style for a point or series in a line, scatter, or radar chart.
Example::
from pptx.enum.chart import XL_MARKER_STYLE
series.marker.style = XL_MARKER_STYLE.CIRCLE
MS API Name: `XlMarkerStyle`
http://msdn.microsoft.com/en-us/library/office/ff197219.aspx
"""
AUTOMATIC = (-4105, "auto", "Automatic markers")
"""Automatic markers"""
CIRCLE = (8, "circle", "Circular markers")
"""Circular markers"""
DASH = (-4115, "dash", "Long bar markers")
"""Long bar markers"""
DIAMOND = (2, "diamond", "Diamond-shaped markers")
"""Diamond-shaped markers"""
DOT = (-4118, "dot", "Short bar markers")
"""Short bar markers"""
NONE = (-4142, "none", "No markers")
"""No markers"""
PICTURE = (-4147, "picture", "Picture markers")
"""Picture markers"""
PLUS = (9, "plus", "Square markers with a plus sign")
"""Square markers with a plus sign"""
SQUARE = (1, "square", "Square markers")
"""Square markers"""
STAR = (5, "star", "Square markers with an asterisk")
"""Square markers with an asterisk"""
TRIANGLE = (3, "triangle", "Triangular markers")
"""Triangular markers"""
X = (-4168, "x", "Square markers with an X")
"""Square markers with an X"""
class XL_TICK_MARK(BaseXmlEnum):
"""Specifies a type of axis tick for a chart.
Example::
from pptx.enum.chart import XL_TICK_MARK
chart.value_axis.minor_tick_mark = XL_TICK_MARK.INSIDE
MS API Name: `XlTickMark`
http://msdn.microsoft.com/en-us/library/office/ff193878.aspx
"""
CROSS = (4, "cross", "Tick mark crosses the axis")
"""Tick mark crosses the axis"""
INSIDE = (2, "in", "Tick mark appears inside the axis")
"""Tick mark appears inside the axis"""
NONE = (-4142, "none", "No tick mark")
"""No tick mark"""
OUTSIDE = (3, "out", "Tick mark appears outside the axis")
"""Tick mark appears outside the axis"""
class XL_TICK_LABEL_POSITION(BaseXmlEnum):
"""Specifies the position of tick-mark labels on a chart axis.
Example::
from pptx.enum.chart import XL_TICK_LABEL_POSITION
category_axis = chart.category_axis
category_axis.tick_label_position = XL_TICK_LABEL_POSITION.LOW
MS API Name: `XlTickLabelPosition`
http://msdn.microsoft.com/en-us/library/office/ff822561.aspx
"""
HIGH = (-4127, "high", "Top or right side of the chart.")
"""Top or right side of the chart."""
LOW = (-4134, "low", "Bottom or left side of the chart.")
"""Bottom or left side of the chart."""
NEXT_TO_AXIS = (4, "nextTo", "Next to axis (where axis is not at either side of the chart).")
"""Next to axis (where axis is not at either side of the chart)."""
NONE = (-4142, "none", "No tick labels.")
"""No tick labels."""
|
