-
Notifications
You must be signed in to change notification settings - Fork 1
/
chart.h
3627 lines (3234 loc) · 108 KB
/
chart.h
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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* libxlsxwriter
*
* Copyright 2014-2018, John McNamara, [email protected]. See LICENSE.txt.
*
* chart - A libxlsxwriter library for creating Excel XLSX chart files.
*
*/
/**
* @page chart_page The Chart object
*
* The Chart object represents an Excel chart. It provides functions for
* adding data series to the chart and for configuring the chart.
*
* See @ref chart.h for full details of the functionality.
*
* @file chart.h
*
* @brief Functions related to adding data to and configuring a chart.
*
* The Chart object represents an Excel chart. It provides functions for
* adding data series to the chart and for configuring the chart.
*
* A Chart object isn't created directly. Instead a chart is created by
* calling the `workbook_add_chart()` function from a Workbook object. For
* example:
*
* @code
*
* #include "xlsxwriter.h"
*
* int main() {
*
* lxw_workbook *workbook = new_workbook("chart.xlsx");
* lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
*
* // User function to add data to worksheet, not shown here.
* write_worksheet_data(worksheet);
*
* // Create a chart object.
* lxw_chart *chart = workbook_add_chart(workbook, LXW_CHART_COLUMN);
*
* // In the simplest case we just add some value data series.
* // The NULL categories will default to 1 to 5 like in Excel.
* chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$5");
* chart_add_series(chart, NULL, "=Sheet1!$B$1:$B$5");
* chart_add_series(chart, NULL, "=Sheet1!$C$1:$C$5");
*
* // Insert the chart into the worksheet
* worksheet_insert_chart(worksheet, CELL("B7"), chart);
*
* return workbook_close(workbook);
* }
*
* @endcode
*
* The chart in the worksheet will look like this:
* @image html chart_simple.png
*
* The basic procedure for adding a chart to a worksheet is:
*
* 1. Create the chart with `workbook_add_chart()`.
* 2. Add one or more data series to the chart which refers to data in the
* workbook using `chart_add_series()`.
* 3. Configure the chart with the other available functions shown below.
* 4. Insert the chart into a worksheet using `worksheet_insert_chart()`.
*
*/
#ifndef __LXW_CHART_H__
#define __LXW_CHART_H__
#include <stdint.h>
#include <string.h>
#include "common.h"
#include "format.h"
STAILQ_HEAD(lxw_chart_series_list, lxw_chart_series);
STAILQ_HEAD(lxw_series_data_points, lxw_series_data_point);
#define LXW_CHART_NUM_FORMAT_LEN 128
#define LXW_CHART_DEFAULT_GAP 501
/**
* @brief Available chart types.
*/
typedef enum lxw_chart_type {
/** None. */
LXW_CHART_NONE = 0,
/** Area chart. */
LXW_CHART_AREA,
/** Area chart - stacked. */
LXW_CHART_AREA_STACKED,
/** Area chart - percentage stacked. */
LXW_CHART_AREA_STACKED_PERCENT,
/** Bar chart. */
LXW_CHART_BAR,
/** Bar chart - stacked. */
LXW_CHART_BAR_STACKED,
/** Bar chart - percentage stacked. */
LXW_CHART_BAR_STACKED_PERCENT,
/** Column chart. */
LXW_CHART_COLUMN,
/** Column chart - stacked. */
LXW_CHART_COLUMN_STACKED,
/** Column chart - percentage stacked. */
LXW_CHART_COLUMN_STACKED_PERCENT,
/** Doughnut chart. */
LXW_CHART_DOUGHNUT,
/** Line chart. */
LXW_CHART_LINE,
/** Pie chart. */
LXW_CHART_PIE,
/** Scatter chart. */
LXW_CHART_SCATTER,
/** Scatter chart - straight. */
LXW_CHART_SCATTER_STRAIGHT,
/** Scatter chart - straight with markers. */
LXW_CHART_SCATTER_STRAIGHT_WITH_MARKERS,
/** Scatter chart - smooth. */
LXW_CHART_SCATTER_SMOOTH,
/** Scatter chart - smooth with markers. */
LXW_CHART_SCATTER_SMOOTH_WITH_MARKERS,
/** Radar chart. */
LXW_CHART_RADAR,
/** Radar chart - with markers. */
LXW_CHART_RADAR_WITH_MARKERS,
/** Radar chart - filled. */
LXW_CHART_RADAR_FILLED
} lxw_chart_type;
/**
* @brief Chart legend positions.
*/
typedef enum lxw_chart_legend_position {
/** No chart legend. */
LXW_CHART_LEGEND_NONE = 0,
/** Chart legend positioned at right side. */
LXW_CHART_LEGEND_RIGHT,
/** Chart legend positioned at left side. */
LXW_CHART_LEGEND_LEFT,
/** Chart legend positioned at top. */
LXW_CHART_LEGEND_TOP,
/** Chart legend positioned at bottom. */
LXW_CHART_LEGEND_BOTTOM,
/** Chart legend positioned at top right. */
LXW_CHART_LEGEND_TOP_RIGHT,
/** Chart legend overlaid at right side. */
LXW_CHART_LEGEND_OVERLAY_RIGHT,
/** Chart legend overlaid at left side. */
LXW_CHART_LEGEND_OVERLAY_LEFT,
/** Chart legend overlaid at top right. */
LXW_CHART_LEGEND_OVERLAY_TOP_RIGHT
} lxw_chart_legend_position;
/**
* @brief Chart line dash types.
*
* The dash types are shown in the order that they appear in the Excel dialog.
* See @ref chart_lines.
*/
typedef enum lxw_chart_line_dash_type {
/** Solid. */
LXW_CHART_LINE_DASH_SOLID = 0,
/** Round Dot. */
LXW_CHART_LINE_DASH_ROUND_DOT,
/** Square Dot. */
LXW_CHART_LINE_DASH_SQUARE_DOT,
/** Dash. */
LXW_CHART_LINE_DASH_DASH,
/** Dash Dot. */
LXW_CHART_LINE_DASH_DASH_DOT,
/** Long Dash. */
LXW_CHART_LINE_DASH_LONG_DASH,
/** Long Dash Dot. */
LXW_CHART_LINE_DASH_LONG_DASH_DOT,
/** Long Dash Dot Dot. */
LXW_CHART_LINE_DASH_LONG_DASH_DOT_DOT,
/* These aren't available in the dialog but are used by Excel. */
LXW_CHART_LINE_DASH_DOT,
LXW_CHART_LINE_DASH_SYSTEM_DASH_DOT,
LXW_CHART_LINE_DASH_SYSTEM_DASH_DOT_DOT
} lxw_chart_line_dash_type;
/**
* @brief Chart marker types.
*/
typedef enum lxw_chart_marker_type {
/** Automatic, series default, marker type. */
LXW_CHART_MARKER_AUTOMATIC,
/** No marker type. */
LXW_CHART_MARKER_NONE,
/** Square marker type. */
LXW_CHART_MARKER_SQUARE,
/** Diamond marker type. */
LXW_CHART_MARKER_DIAMOND,
/** Triangle marker type. */
LXW_CHART_MARKER_TRIANGLE,
/** X shape marker type. */
LXW_CHART_MARKER_X,
/** Star marker type. */
LXW_CHART_MARKER_STAR,
/** Short dash marker type. */
LXW_CHART_MARKER_SHORT_DASH,
/** Long dash marker type. */
LXW_CHART_MARKER_LONG_DASH,
/** Circle marker type. */
LXW_CHART_MARKER_CIRCLE,
/** Plus (+) marker type. */
LXW_CHART_MARKER_PLUS
} lxw_chart_marker_type;
/**
* @brief Chart pattern types.
*/
typedef enum lxw_chart_pattern_type {
/** None pattern. */
LXW_CHART_PATTERN_NONE,
/** 5 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_5,
/** 10 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_10,
/** 20 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_20,
/** 25 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_25,
/** 30 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_30,
/** 40 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_40,
/** 50 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_50,
/** 60 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_60,
/** 70 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_70,
/** 75 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_75,
/** 80 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_80,
/** 90 Percent pattern. */
LXW_CHART_PATTERN_PERCENT_90,
/** Light downward diagonal pattern. */
LXW_CHART_PATTERN_LIGHT_DOWNWARD_DIAGONAL,
/** Light upward diagonal pattern. */
LXW_CHART_PATTERN_LIGHT_UPWARD_DIAGONAL,
/** Dark downward diagonal pattern. */
LXW_CHART_PATTERN_DARK_DOWNWARD_DIAGONAL,
/** Dark upward diagonal pattern. */
LXW_CHART_PATTERN_DARK_UPWARD_DIAGONAL,
/** Wide downward diagonal pattern. */
LXW_CHART_PATTERN_WIDE_DOWNWARD_DIAGONAL,
/** Wide upward diagonal pattern. */
LXW_CHART_PATTERN_WIDE_UPWARD_DIAGONAL,
/** Light vertical pattern. */
LXW_CHART_PATTERN_LIGHT_VERTICAL,
/** Light horizontal pattern. */
LXW_CHART_PATTERN_LIGHT_HORIZONTAL,
/** Narrow vertical pattern. */
LXW_CHART_PATTERN_NARROW_VERTICAL,
/** Narrow horizontal pattern. */
LXW_CHART_PATTERN_NARROW_HORIZONTAL,
/** Dark vertical pattern. */
LXW_CHART_PATTERN_DARK_VERTICAL,
/** Dark horizontal pattern. */
LXW_CHART_PATTERN_DARK_HORIZONTAL,
/** Dashed downward diagonal pattern. */
LXW_CHART_PATTERN_DASHED_DOWNWARD_DIAGONAL,
/** Dashed upward diagonal pattern. */
LXW_CHART_PATTERN_DASHED_UPWARD_DIAGONAL,
/** Dashed horizontal pattern. */
LXW_CHART_PATTERN_DASHED_HORIZONTAL,
/** Dashed vertical pattern. */
LXW_CHART_PATTERN_DASHED_VERTICAL,
/** Small confetti pattern. */
LXW_CHART_PATTERN_SMALL_CONFETTI,
/** Large confetti pattern. */
LXW_CHART_PATTERN_LARGE_CONFETTI,
/** Zigzag pattern. */
LXW_CHART_PATTERN_ZIGZAG,
/** Wave pattern. */
LXW_CHART_PATTERN_WAVE,
/** Diagonal brick pattern. */
LXW_CHART_PATTERN_DIAGONAL_BRICK,
/** Horizontal brick pattern. */
LXW_CHART_PATTERN_HORIZONTAL_BRICK,
/** Weave pattern. */
LXW_CHART_PATTERN_WEAVE,
/** Plaid pattern. */
LXW_CHART_PATTERN_PLAID,
/** Divot pattern. */
LXW_CHART_PATTERN_DIVOT,
/** Dotted grid pattern. */
LXW_CHART_PATTERN_DOTTED_GRID,
/** Dotted diamond pattern. */
LXW_CHART_PATTERN_DOTTED_DIAMOND,
/** Shingle pattern. */
LXW_CHART_PATTERN_SHINGLE,
/** Trellis pattern. */
LXW_CHART_PATTERN_TRELLIS,
/** Sphere pattern. */
LXW_CHART_PATTERN_SPHERE,
/** Small grid pattern. */
LXW_CHART_PATTERN_SMALL_GRID,
/** Large grid pattern. */
LXW_CHART_PATTERN_LARGE_GRID,
/** Small check pattern. */
LXW_CHART_PATTERN_SMALL_CHECK,
/** Large check pattern. */
LXW_CHART_PATTERN_LARGE_CHECK,
/** Outlined diamond pattern. */
LXW_CHART_PATTERN_OUTLINED_DIAMOND,
/** Solid diamond pattern. */
LXW_CHART_PATTERN_SOLID_DIAMOND
} lxw_chart_pattern_type;
/**
* @brief Chart data label positions.
*/
typedef enum lxw_chart_label_position {
/** Series data label position: default position. */
LXW_CHART_LABEL_POSITION_DEFAULT,
/** Series data label position: center. */
LXW_CHART_LABEL_POSITION_CENTER,
/** Series data label position: right. */
LXW_CHART_LABEL_POSITION_RIGHT,
/** Series data label position: left. */
LXW_CHART_LABEL_POSITION_LEFT,
/** Series data label position: above. */
LXW_CHART_LABEL_POSITION_ABOVE,
/** Series data label position: below. */
LXW_CHART_LABEL_POSITION_BELOW,
/** Series data label position: inside base. */
LXW_CHART_LABEL_POSITION_INSIDE_BASE,
/** Series data label position: inside end. */
LXW_CHART_LABEL_POSITION_INSIDE_END,
/** Series data label position: outside end. */
LXW_CHART_LABEL_POSITION_OUTSIDE_END,
/** Series data label position: best fit. */
LXW_CHART_LABEL_POSITION_BEST_FIT
} lxw_chart_label_position;
/**
* @brief Chart data label separator.
*/
typedef enum lxw_chart_label_separator {
/** Series data label separator: comma (the default). */
LXW_CHART_LABEL_SEPARATOR_COMMA,
/** Series data label separator: semicolon. */
LXW_CHART_LABEL_SEPARATOR_SEMICOLON,
/** Series data label separator: period. */
LXW_CHART_LABEL_SEPARATOR_PERIOD,
/** Series data label separator: newline. */
LXW_CHART_LABEL_SEPARATOR_NEWLINE,
/** Series data label separator: space. */
LXW_CHART_LABEL_SEPARATOR_SPACE
} lxw_chart_label_separator;
/**
* @brief Chart axis types.
*/
typedef enum lxw_chart_axis_type {
/** Chart X axis. */
LXW_CHART_AXIS_TYPE_X,
/** Chart Y axis. */
LXW_CHART_AXIS_TYPE_Y
} lxw_chart_axis_type;
enum lxw_chart_subtype {
LXW_CHART_SUBTYPE_NONE = 0,
LXW_CHART_SUBTYPE_STACKED,
LXW_CHART_SUBTYPE_STACKED_PERCENT
};
enum lxw_chart_grouping {
LXW_GROUPING_CLUSTERED,
LXW_GROUPING_STANDARD,
LXW_GROUPING_PERCENTSTACKED,
LXW_GROUPING_STACKED
};
/**
* @brief Axis positions for category axes.
*/
typedef enum lxw_chart_axis_tick_position {
LXW_CHART_AXIS_POSITION_DEFAULT,
/** Position category axis on tick marks. */
LXW_CHART_AXIS_POSITION_ON_TICK,
/** Position category axis between tick marks. */
LXW_CHART_AXIS_POSITION_BETWEEN
} lxw_chart_axis_tick_position;
/**
* @brief Axis label positions.
*/
typedef enum lxw_chart_axis_label_position {
/** Position the axis labels next to the axis. The default. */
LXW_CHART_AXIS_LABEL_POSITION_NEXT_TO,
/** Position the axis labels at the top of the chart, for horizontal
* axes, or to the right for vertical axes.*/
LXW_CHART_AXIS_LABEL_POSITION_HIGH,
/** Position the axis labels at the bottom of the chart, for horizontal
* axes, or to the left for vertical axes.*/
LXW_CHART_AXIS_LABEL_POSITION_LOW,
/** Turn off the the axis labels. */
LXW_CHART_AXIS_LABEL_POSITION_NONE
} lxw_chart_axis_label_position;
/**
* @brief Axis label alignments.
*/
typedef enum lxw_chart_axis_label_alignment {
/** Chart axis label alignment: center. */
LXW_CHART_AXIS_LABEL_ALIGN_CENTER,
/** Chart axis label alignment: left. */
LXW_CHART_AXIS_LABEL_ALIGN_LEFT,
/** Chart axis label alignment: right. */
LXW_CHART_AXIS_LABEL_ALIGN_RIGHT
} lxw_chart_axis_label_alignment;
/**
* @brief Display units for chart value axis.
*/
typedef enum lxw_chart_axis_display_unit {
/** Axis display units: None. The default. */
LXW_CHART_AXIS_UNITS_NONE,
/** Axis display units: Hundreds. */
LXW_CHART_AXIS_UNITS_HUNDREDS,
/** Axis display units: Thousands. */
LXW_CHART_AXIS_UNITS_THOUSANDS,
/** Axis display units: Ten thousands. */
LXW_CHART_AXIS_UNITS_TEN_THOUSANDS,
/** Axis display units: Hundred thousands. */
LXW_CHART_AXIS_UNITS_HUNDRED_THOUSANDS,
/** Axis display units: Millions. */
LXW_CHART_AXIS_UNITS_MILLIONS,
/** Axis display units: Ten millions. */
LXW_CHART_AXIS_UNITS_TEN_MILLIONS,
/** Axis display units: Hundred millions. */
LXW_CHART_AXIS_UNITS_HUNDRED_MILLIONS,
/** Axis display units: Billions. */
LXW_CHART_AXIS_UNITS_BILLIONS,
/** Axis display units: Trillions. */
LXW_CHART_AXIS_UNITS_TRILLIONS
} lxw_chart_axis_display_unit;
/**
* @brief Tick mark types for an axis.
*/
typedef enum lxw_chart_axis_tick_mark {
/** Default tick mark for the chart axis. Usually outside. */
LXW_CHART_AXIS_TICK_MARK_DEFAULT,
/** No tick mark for the axis. */
LXW_CHART_AXIS_TICK_MARK_NONE,
/** Tick mark inside the axis only. */
LXW_CHART_AXIS_TICK_MARK_INSIDE,
/** Tick mark outside the axis only. */
LXW_CHART_AXIS_TICK_MARK_OUTSIDE,
/** Tick mark inside and outside the axis. */
LXW_CHART_AXIS_TICK_MARK_CROSSING
} lxw_chart_tick_mark;
typedef struct lxw_series_range {
char *formula;
char *sheetname;
lxw_row_t first_row;
lxw_row_t last_row;
lxw_col_t first_col;
lxw_col_t last_col;
uint8_t ignore_cache;
uint8_t has_string_cache;
uint16_t num_data_points;
struct lxw_series_data_points *data_cache;
} lxw_series_range;
typedef struct lxw_series_data_point {
uint8_t is_string;
double number;
char *string;
uint8_t no_data;
STAILQ_ENTRY (lxw_series_data_point) list_pointers;
} lxw_series_data_point;
/**
* @brief Struct to represent a chart line.
*
* See @ref chart_lines.
*/
typedef struct lxw_chart_line {
/** The chart font color. See @ref working_with_colors. */
lxw_color_t color;
/** Turn off/hide line. Set to 0 or 1.*/
uint8_t none;
/** Width of the line in increments of 0.25. Default is 2.25. */
float width;
/** The line dash type. See #lxw_chart_line_dash_type. */
uint8_t dash_type;
/** Set the transparency of the line. 0 - 100. Default 0. */
uint8_t transparency;
/* Members for internal use only. */
uint8_t has_color;
} lxw_chart_line;
/**
* @brief Struct to represent a chart fill.
*
* See @ref chart_fills.
*/
typedef struct lxw_chart_fill {
/** The chart font color. See @ref working_with_colors. */
lxw_color_t color;
/** Turn off/hide line. Set to 0 or 1.*/
uint8_t none;
/** Set the transparency of the fill. 0 - 100. Default 0. */
uint8_t transparency;
/* Members for internal use only. */
uint8_t has_color;
} lxw_chart_fill;
/**
* @brief Struct to represent a chart pattern.
*
* See @ref chart_patterns.
*/
typedef struct lxw_chart_pattern {
/** The pattern foreground color. See @ref working_with_colors. */
lxw_color_t fg_color;
/** The pattern background color. See @ref working_with_colors. */
lxw_color_t bg_color;
/** The pattern type. See #lxw_chart_pattern_type. */
uint8_t type;
/* Members for internal use only. */
uint8_t has_fg_color;
uint8_t has_bg_color;
} lxw_chart_pattern;
/**
* @brief Struct to represent a chart font.
*
* See @ref chart_fonts.
*/
typedef struct lxw_chart_font {
/** The chart font name, such as "Arial" or "Calibri". */
char *name;
/** The chart font size. The default is 11. */
double size;
/** The chart font bold property. Set to 0 or 1. */
uint8_t bold;
/** The chart font italic property. Set to 0 or 1. */
uint8_t italic;
/** The chart font underline property. Set to 0 or 1. */
uint8_t underline;
/** The chart font rotation property. Range: -90 to 90. */
int32_t rotation;
/** The chart font color. See @ref working_with_colors. */
lxw_color_t color;
/** The chart font pitch family property. Rarely required. set to 0. */
uint8_t pitch_family;
/** The chart font character set property. Rarely required. set to 0. */
uint8_t charset;
/** The chart font baseline property. Rarely required. set to 0. */
int8_t baseline;
/* Members for internal use only. */
uint8_t has_color;
} lxw_chart_font;
typedef struct lxw_chart_marker {
uint8_t type;
uint8_t size;
lxw_chart_line *line;
lxw_chart_fill *fill;
lxw_chart_pattern *pattern;
} lxw_chart_marker;
typedef struct lxw_chart_legend {
lxw_chart_font *font;
uint8_t position;
} lxw_chart_legend;
typedef struct lxw_chart_title {
char *name;
lxw_row_t row;
lxw_col_t col;
lxw_chart_font *font;
uint8_t off;
uint8_t is_horizontal;
uint8_t ignore_cache;
/* We use a range to hold the title formula properties even though it
* will only have 1 point in order to re-use similar functions.*/
lxw_series_range *range;
struct lxw_series_data_point data_point;
} lxw_chart_title;
/**
* @brief Struct to represent an Excel chart data point.
*
* The lxw_chart_point used to set the line, fill and pattern of one or more
* points in a chart data series. See @ref chart_points.
*/
typedef struct lxw_chart_point {
/** The line/border for the chart point. See @ref chart_lines. */
lxw_chart_line *line;
/** The fill for the chart point. See @ref chart_fills. */
lxw_chart_fill *fill;
/** The pattern for the chart point. See @ref chart_patterns.*/
lxw_chart_pattern *pattern;
} lxw_chart_point;
/**
* @brief Define how blank values are displayed in a chart.
*/
typedef enum lxw_chart_blank {
/** Show empty chart cells as gaps in the data. The default. */
LXW_CHART_BLANKS_AS_GAP,
/** Show empty chart cells as zeros. */
LXW_CHART_BLANKS_AS_ZERO,
/** Show empty chart cells as connected. Only for charts with lines. */
LXW_CHART_BLANKS_AS_CONNECTED
} lxw_chart_blank;
enum lxw_chart_position {
LXW_CHART_AXIS_RIGHT,
LXW_CHART_AXIS_LEFT,
LXW_CHART_AXIS_TOP,
LXW_CHART_AXIS_BOTTOM
};
/**
* @brief Type/amount of data series error bar.
*/
typedef enum lxw_chart_error_bar_type {
/** Error bar type: Standard error. */
LXW_CHART_ERROR_BAR_TYPE_STD_ERROR,
/** Error bar type: Fixed value. */
LXW_CHART_ERROR_BAR_TYPE_FIXED,
/** Error bar type: Percentage. */
LXW_CHART_ERROR_BAR_TYPE_PERCENTAGE,
/** Error bar type: Standard deviation(s). */
LXW_CHART_ERROR_BAR_TYPE_STD_DEV
} lxw_chart_error_bar_type;
/**
* @brief Direction for a data series error bar.
*/
typedef enum lxw_chart_error_bar_direction {
/** Error bar extends in both directions. The default. */
LXW_CHART_ERROR_BAR_DIR_BOTH,
/** Error bar extends in positive direction. */
LXW_CHART_ERROR_BAR_DIR_PLUS,
/** Error bar extends in negative direction. */
LXW_CHART_ERROR_BAR_DIR_MINUS
} lxw_chart_error_bar_direction;
/**
* @brief Direction for a data series error bar.
*/
typedef enum lxw_chart_error_bar_axis {
/** X axis error bar. */
LXW_CHART_ERROR_BAR_AXIS_X,
/** Y axis error bar. */
LXW_CHART_ERROR_BAR_AXIS_Y
} lxw_chart_error_bar_axis;
/**
* @brief End cap styles for a data series error bar.
*/
typedef enum lxw_chart_error_bar_cap {
/** Flat end cap. The default. */
LXW_CHART_ERROR_BAR_END_CAP,
/** No end cap. */
LXW_CHART_ERROR_BAR_NO_CAP
} lxw_chart_error_bar_cap;
typedef struct lxw_series_error_bars {
uint8_t type;
uint8_t direction;
uint8_t endcap;
uint8_t has_value;
uint8_t is_set;
uint8_t is_x;
uint8_t chart_group;
double value;
lxw_chart_line *line;
} lxw_series_error_bars;
/**
* @brief Series trendline/regression types.
*/
typedef enum lxw_chart_trendline_type {
/** Trendline type: Linear. */
LXW_CHART_TRENDLINE_TYPE_LINEAR,
/** Trendline type: Logarithm. */
LXW_CHART_TRENDLINE_TYPE_LOG,
/** Trendline type: Polynomial. */
LXW_CHART_TRENDLINE_TYPE_POLY,
/** Trendline type: Power. */
LXW_CHART_TRENDLINE_TYPE_POWER,
/** Trendline type: Exponential. */
LXW_CHART_TRENDLINE_TYPE_EXP,
/** Trendline type: Moving Average. */
LXW_CHART_TRENDLINE_TYPE_AVERAGE
} lxw_chart_trendline_type;
/**
* @brief Struct to represent an Excel chart data series.
*
* The lxw_chart_series is created using the chart_add_series function. It is
* used in functions that modify a chart series but the members of the struct
* aren't modified directly.
*/
typedef struct lxw_chart_series {
lxw_series_range *categories;
lxw_series_range *values;
lxw_chart_title title;
lxw_chart_line *line;
lxw_chart_fill *fill;
lxw_chart_pattern *pattern;
lxw_chart_marker *marker;
lxw_chart_point *points;
uint16_t point_count;
uint8_t smooth;
uint8_t invert_if_negative;
/* Data label parameters. */
uint8_t has_labels;
uint8_t show_labels_value;
uint8_t show_labels_category;
uint8_t show_labels_name;
uint8_t show_labels_leader;
uint8_t show_labels_legend;
uint8_t show_labels_percent;
uint8_t label_position;
uint8_t label_separator;
uint8_t default_label_position;
char *label_num_format;
lxw_chart_font *label_font;
lxw_series_error_bars *x_error_bars;
lxw_series_error_bars *y_error_bars;
uint8_t has_trendline;
uint8_t has_trendline_forecast;
uint8_t has_trendline_equation;
uint8_t has_trendline_r_squared;
uint8_t has_trendline_intercept;
uint8_t trendline_type;
uint8_t trendline_value;
double trendline_forward;
double trendline_backward;
uint8_t trendline_value_type;
char *trendline_name;
lxw_chart_line *trendline_line;
double trendline_intercept;
STAILQ_ENTRY (lxw_chart_series) list_pointers;
} lxw_chart_series;
/* Struct for major/minor axis gridlines. */
typedef struct lxw_chart_gridline {
uint8_t visible;
lxw_chart_line *line;
} lxw_chart_gridline;
/**
* @brief Struct to represent an Excel chart axis.
*
* The lxw_chart_axis struct is used in functions that modify a chart axis
* but the members of the struct aren't modified directly.
*/
typedef struct lxw_chart_axis {
lxw_chart_title title;
char *num_format;
char *default_num_format;
uint8_t source_linked;
uint8_t major_tick_mark;
uint8_t minor_tick_mark;
uint8_t is_horizontal;
lxw_chart_gridline major_gridlines;
lxw_chart_gridline minor_gridlines;
lxw_chart_font *num_font;
lxw_chart_line *line;
lxw_chart_fill *fill;
lxw_chart_pattern *pattern;
uint8_t is_category;
uint8_t is_date;
uint8_t is_value;