Initial working chart points.

.indent.pro

@@ -64,6 +64,7 @@
 -T lxw_chart_marker_type
 -T lxw_chart_pattern
 -T lxw_chart_pattern_type
+-T lxw_chart_point
 -T lxw_chart_series
 -T lxw_chart_title
 -T lxw_chart_type

include/xlsxwriter/chart.h

@@ -686,6 +686,14 @@ typedef struct lxw_chart_title {
 
 } lxw_chart_title;
 
+typedef struct lxw_chart_point {
+
+    lxw_chart_line *line;
+    lxw_chart_fill *fill;
+    lxw_chart_pattern *pattern;
+
+} lxw_chart_point;
+
 /**
  * @brief Struct to represent an Excel chart data series.
  *
@@ -702,6 +710,8 @@ typedef struct lxw_chart_series {
     lxw_chart_fill *fill;
     lxw_chart_pattern *pattern;
     lxw_chart_marker *marker;
+    lxw_chart_point *points;
+    uint16_t point_count;
 
     uint8_t invert_if_negative;
 
@@ -1285,6 +1295,9 @@ void chart_series_set_marker_fill(lxw_chart_series *series,
 void chart_series_set_marker_pattern(lxw_chart_series *series,
                                      lxw_chart_pattern *pattern);
 
+lxw_error chart_series_set_points(lxw_chart_series *series,
+                                  lxw_chart_point *points[]);
+
 /**
  * @brief Set the name caption of the an axis.
  *

src/chart.c

@@ -52,6 +52,23 @@ _chart_free_range(lxw_series_range *range)
     free(range);
 }
 
+STATIC void
+_chart_free_points(lxw_chart_series *series)
+{
+    uint16_t index;
+
+    for (index = 0; index < series->point_count; index++) {
+        lxw_chart_point *point = &series->points[index];
+
+        free(point->line);
+        free(point->fill);
+        free(point->pattern);
+    }
+
+    series->point_count = 0;
+    free(series->points);
+}
+
 /*
  * Free a series object.
  */
@@ -76,6 +93,7 @@ _chart_series_free(lxw_chart_series *series)
     _chart_free_range(series->categories);
     _chart_free_range(series->values);
     _chart_free_range(series->title.range);
+    _chart_free_points(series);
 
     free(series);
 }
@@ -1917,6 +1935,50 @@ _chart_write_symbol(lxw_chart *self, uint8_t type)
     LXW_FREE_ATTRIBUTES();
 }
 
+/*
+ * Write the <c:dPt> element.
+ */
+STATIC void
+_chart_write_d_pt(lxw_chart *self, lxw_chart_point *point, uint16_t index)
+{
+    lxw_xml_start_tag(self->file, "c:dPt", NULL);
+
+    /* Write the c:idx element. */
+    _chart_write_idx(self, index);
+
+    /* Scatter/Line charts have an additional marker for the point. */
+    if (self->is_scatter_chart || self->type == LXW_CHART_LINE)
+        lxw_xml_start_tag(self->file, "c:marker", NULL);
+
+    /* Write the c:spPr element. */
+    _chart_write_sp_pr(self, point->line, point->fill, point->pattern);
+
+    if (self->is_scatter_chart || self->type == LXW_CHART_LINE)
+        lxw_xml_end_tag(self->file, "c:marker");
+
+    lxw_xml_end_tag(self->file, "c:dPt");
+}
+
+/*
+ * Write the <c:dPt> element.
+ */
+STATIC void
+_chart_write_points(lxw_chart *self, lxw_chart_series *series)
+{
+    uint16_t index;
+
+    for (index = 0; index < series->point_count; index++) {
+        lxw_chart_point *point = &series->points[index];
+
+        /* Ignore empty points. */
+        if (!point->line && !point->fill && !point->pattern)
+            continue;
+
+        /* Write the c:dPt element. */
+        _chart_write_d_pt(self, &series->points[index], index);
+    }
+}
+
 /*
  * Write the <c:invertIfNegative> element.
  */
@@ -2140,6 +2202,9 @@ _chart_write_ser(lxw_chart *self, lxw_chart_series *series)
     /* Write the c:invertIfNegative element. */
     _chart_write_invert_if_negative(self, series);
 
+    /* Write the char points. */
+    _chart_write_points(self, series);
+
     /* Write the c:cat element. */
     _chart_write_cat(self, series);
 
@@ -2175,6 +2240,9 @@ _chart_write_xval_ser(lxw_chart *self, lxw_chart_series *series)
     /* Write the c:marker element. */
     _chart_write_marker(self, series->marker);
 
+    /* Write the char points. */
+    _chart_write_points(self, series);
+
     /* Write the c:xVal element. */
     _chart_write_x_val(self, series);
 
@@ -4169,6 +4237,41 @@ chart_series_set_marker_pattern(lxw_chart_series *series,
     series->marker->pattern = _chart_convert_pattern_args(pattern);
 }
 
+/*
+ * Store the horizontal page breaks on a worksheet.
+ */
+lxw_error
+chart_series_set_points(lxw_chart_series *series, lxw_chart_point *points[])
+{
+    uint16_t i = 0;
+    uint16_t point_count = 0;
+
+    if (points == NULL)
+        return LXW_ERROR_NULL_PARAMETER_IGNORED;
+
+    while (points[point_count])
+        point_count++;
+
+    /* Free any existing resource. */
+    _chart_free_points(series);
+
+    series->points = calloc(point_count, sizeof(lxw_chart_point));
+    RETURN_ON_MEM_ERROR(series->points, LXW_ERROR_MEMORY_MALLOC_FAILED);
+
+    for (i = 0; i < point_count; i++) {
+        lxw_chart_point *src_point = points[i];
+        lxw_chart_point *dst_point = &series->points[i];
+
+        dst_point->line = _chart_convert_line_args(src_point->line);
+        dst_point->fill = _chart_convert_fill_args(src_point->fill);
+        dst_point->pattern = _chart_convert_pattern_args(src_point->pattern);
+    }
+
+    series->point_count = point_count;
+
+    return LXW_NO_ERROR;
+}
+
 /*
  * Set an axis caption.
  */

test/functional/src/test_chart_points01.c

@@ -0,0 +1,38 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_points01.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_PIE);
+
+    worksheet_write_number(worksheet, 0, 0, 2, NULL);
+    worksheet_write_number(worksheet, 1, 0, 5, NULL);
+    worksheet_write_number(worksheet, 2, 0, 4, NULL);
+    worksheet_write_number(worksheet, 3, 0, 1, NULL);
+    worksheet_write_number(worksheet, 4, 0, 7, NULL);
+    worksheet_write_number(worksheet, 5, 0, 4, NULL);
+
+    lxw_chart_series *series = chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$6");
+
+
+    lxw_chart_fill fill1 = {.color = LXW_COLOR_RED};
+    lxw_chart_point point1 = {.fill = &fill1};
+    lxw_chart_point *points[] = {&point1, NULL};
+
+
+    chart_series_set_points(series, points);
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_chart_points02.c

@@ -0,0 +1,47 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_points02.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_PIE);
+
+    worksheet_write_number(worksheet, 0, 0, 2, NULL);
+    worksheet_write_number(worksheet, 1, 0, 5, NULL);
+    worksheet_write_number(worksheet, 2, 0, 4, NULL);
+    worksheet_write_number(worksheet, 3, 0, 1, NULL);
+    worksheet_write_number(worksheet, 4, 0, 7, NULL);
+    worksheet_write_number(worksheet, 5, 0, 4, NULL);
+
+    lxw_chart_series *series = chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$6");
+
+    lxw_chart_line line1 = {.color     = LXW_COLOR_RED,
+                            .dash_type = LXW_CHART_LINE_DASH_SQUARE_DOT};
+
+    lxw_chart_fill fill1 = {.color = LXW_COLOR_YELLOW};
+
+    lxw_chart_point default_point = {0, 0, 0};
+    lxw_chart_point point2 = {.line = &line1};
+    lxw_chart_point point4 = {.fill = &fill1};
+
+    lxw_chart_point *points[] = {&default_point,
+                                 &point2,
+                                 &default_point,
+                                 &point4,
+                                 NULL};
+
+    chart_series_set_points(series, points);
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_chart_points03.c

@@ -0,0 +1,41 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_points03.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_PIE);
+
+
+    worksheet_write_number(worksheet, 0, 0, 2, NULL);
+    worksheet_write_number(worksheet, 1, 0, 5, NULL);
+    worksheet_write_number(worksheet, 2, 0, 4, NULL);
+
+    lxw_chart_series *series = chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$3");
+
+
+    lxw_chart_fill fill1 = {.color = 0xFF0000};
+    lxw_chart_fill fill2 = {.color = 0xCC0000};
+    lxw_chart_fill fill3 = {.color = 0x990000};
+
+    lxw_chart_point point1 = {.fill = &fill1};
+    lxw_chart_point point2 = {.fill = &fill2};
+    lxw_chart_point point3 = {.fill = &fill3};
+
+    lxw_chart_point *points[] = {&point1, &point2, &point3, NULL};
+
+    chart_series_set_points(series, points);
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_chart_points04.c

@@ -0,0 +1,67 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_points04.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_SCATTER);
+
+    /* For testing, copy the randomly generated axis ids in the target file. */
+    chart->axis_id_1 = 48542464;
+    chart->axis_id_2 = 46807296;
+
+    uint8_t data[5][3] = {
+        {1, 2,  3},
+        {2, 4,  6},
+        {3, 6,  9},
+        {4, 8,  12},
+        {5, 10, 15}
+    };
+
+    int row, col;
+    for (row = 0; row < 5; row++)
+        for (col = 0; col < 3; col++)
+            worksheet_write_number(worksheet, row, col, data[row][col], NULL);
+
+    lxw_chart_series *series1 = chart_add_series(chart,
+         "=Sheet1!$A$1:$A$5",
+         "=Sheet1!$B$1:$B$5"
+    );
+
+    lxw_chart_series *series2 = chart_add_series(chart,
+         "=Sheet1!$A$1:$A$5",
+         "=Sheet1!$C$1:$C$5");
+
+    lxw_chart_fill red_fill    = {.color = LXW_COLOR_RED};
+    lxw_chart_fill yellow_fill = {.color = LXW_COLOR_YELLOW};
+
+    lxw_chart_point default_point = {0, 0, 0};
+    lxw_chart_point red_point     = {.fill = &red_fill};
+    lxw_chart_point yellow_point  = {.fill = &yellow_fill};
+
+    lxw_chart_point *points1[] = {&red_point,
+                                  &yellow_point,
+                                  NULL};
+
+    lxw_chart_point *points2[] = {&default_point,
+                                  &default_point,
+                                  &yellow_point,
+                                  NULL};
+
+    chart_series_set_points(series1, points1);
+    chart_series_set_points(series2, points2);
+
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_chart_points05.c

@@ -0,0 +1,57 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_points05.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_LINE);
+
+    /* For testing, copy the randomly generated axis ids in the target file. */
+    chart->axis_id_1 = 45471616;
+    chart->axis_id_2 = 46804992;
+
+    uint8_t data[5][3] = {
+        {1, 2,  3},
+        {2, 4,  6},
+        {3, 6,  9},
+        {4, 8,  12},
+        {5, 10, 15}
+    };
+
+    int row, col;
+    for (row = 0; row < 5; row++)
+        for (col = 0; col < 3; col++)
+            worksheet_write_number(worksheet, row, col, data[row][col], NULL);
+
+    lxw_chart_series *series1 = chart_add_series(chart,
+         "=Sheet1!$A$1:$A$5",
+         "=Sheet1!$B$1:$B$5"
+    );
+
+    lxw_chart_series *series2 = chart_add_series(chart,
+         "=Sheet1!$A$1:$A$5",
+         "=Sheet1!$C$1:$C$5");
+
+    lxw_chart_fill red_fill    = {.color = LXW_COLOR_RED};
+    lxw_chart_point red_point  = {.fill = &red_fill};
+
+    lxw_chart_point *points[] = {&red_point, NULL};
+
+    chart_series_set_points(series1, points);
+
+    chart_series_set_marker_type(series1, LXW_CHART_MARKER_AUTOMATIC);
+    chart_series_set_marker_type(series2, LXW_CHART_MARKER_AUTOMATIC);
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_chart_points06.c

@@ -0,0 +1,57 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_points06.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_COLUMN);
+
+    /* For testing, copy the randomly generated axis ids in the target file. */
+    chart->axis_id_1 = 71050368;
+    chart->axis_id_2 = 71051904;
+
+    uint8_t data[5][3] = {
+        {1, 2,  3},
+        {2, 4,  6},
+        {3, 6,  9},
+        {4, 8,  12},
+        {5, 10, 15}
+    };
+
+    int row, col;
+    for (row = 0; row < 5; row++)
+        for (col = 0; col < 3; col++)
+            worksheet_write_number(worksheet, row, col, data[row][col], NULL);
+
+    lxw_chart_series *series1 = chart_add_series(chart,
+         "=Sheet1!$A$1:$A$5",
+         "=Sheet1!$B$1:$B$5"
+    );
+
+    lxw_chart_series *series2 = chart_add_series(chart,
+         "=Sheet1!$A$1:$A$5",
+         "=Sheet1!$C$1:$C$5");
+
+    lxw_chart_fill red_fill    = {.color = LXW_COLOR_RED};
+    lxw_chart_point red_point  = {.fill = &red_fill};
+
+    lxw_chart_point *points[] = {&red_point, NULL};
+
+    chart_series_set_points(series1, points);
+
+    chart_series_set_marker_type(series1, LXW_CHART_MARKER_AUTOMATIC);
+    chart_series_set_marker_type(series2, LXW_CHART_MARKER_AUTOMATIC);
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/test_chart_points.py

@@ -0,0 +1,34 @@
+###############################################################################
+#
+# Tests for libxlsxwriter.
+#
+# Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+#
+
+import base_test_class
+
+class TestCompareXLSXFiles(base_test_class.XLSXBaseTest):
+    """
+    Test file created with libxlsxwriter against a file created by Excel.
+
+    """
+
+    def test_chart_points01(self):
+        self.run_exe_test('test_chart_points01')
+
+    def test_chart_points02(self):
+        self.run_exe_test('test_chart_points02')
+
+    def test_chart_points03(self):
+        # Ignore custom colors in styles.xml file.
+        self.ignore_files = ['xl/styles.xml']
+        self.run_exe_test('test_chart_points03')
+
+    def test_chart_points04(self):
+        self.run_exe_test('test_chart_points04')
+
+    def test_chart_points05(self):
+        self.run_exe_test('test_chart_points05')
+
+    def test_chart_points06(self):
+        self.run_exe_test('test_chart_points06')