Initial working chart titles.

.indent.pro

@@ -45,11 +45,13 @@
 /* libxlsxwriter typedefs. */
 -T lxw_app
 -T lxw_autofilter
--T lxw_axis
 -T lxw_border
 -T lxw_cell
 -T lxw_chart
+-T lxw_chart_axis
+-T lxw_chart_font
 -T lxw_chart_series
+-T lxw_chart_title
 -T lxw_col_options
 -T lxw_col_t
 -T lxw_color_t

include/xlsxwriter/chart.h

@@ -134,8 +134,10 @@ typedef struct lxw_series_data_point {
 } lxw_series_data_point;
 
 typedef struct lxw_chart_series {
+
     lxw_series_range *categories;
     lxw_series_range *values;
+    char *name;
 
     STAILQ_ENTRY (lxw_chart_series) list_pointers;
 
@@ -149,7 +151,22 @@ typedef struct lxw_chart_axis {
     uint8_t default_major_gridlines;
     uint8_t major_tick_mark;
 
-} lxw_axis;
+} lxw_chart_axis;
+
+typedef struct lxw_chart_font {
+
+    uint8_t bold;
+
+} lxw_chart_font;
+
+typedef struct lxw_chart_title {
+
+    char *name;
+    lxw_chart_font font;
+    uint8_t has_formula;
+    uint8_t none;
+
+} lxw_chart_title;
 
 /*
  * Struct to represent a chart object.
@@ -162,8 +179,9 @@ typedef struct lxw_chart {
     uint8_t subtype;
     uint16_t series_index;
 
-    lxw_axis x_axis;
-    lxw_axis y_axis;
+    lxw_chart_axis x_axis;
+    lxw_chart_axis y_axis;
+    lxw_chart_title title;
 
     uint32_t id;
     uint32_t axis_id_1;
@@ -179,6 +197,7 @@ typedef struct lxw_chart {
     uint16_t rotation;
     uint16_t hole_size;
 
+    uint8_t no_title;
     uint8_t has_markers;
     uint8_t has_overlap;
     int series_overlap_1;
@@ -208,7 +227,11 @@ int lxw_chart_init_data_cache(lxw_series_range *range);
 lxw_chart_series *chart_add_series(lxw_chart *chart,
                                    char *categories, char *values);
 
+void chart_set_series_name(lxw_chart_series *series, char *name);
+
 void chart_set_style(lxw_chart *chart, uint8_t style_id);
+void chart_set_title(lxw_chart *chart, lxw_chart_title *title);
+
 void chart_set_rotation(lxw_chart *chart, uint16_t rotation);
 void chart_set_hole_size(lxw_chart *chart, uint8_t size);
 

src/chart.c

@@ -93,6 +93,7 @@ lxw_chart_series_free(lxw_chart_series *series)
     lxw_chart_free_range(series->categories);
     lxw_chart_free_range(series->values);
 
+    free(series->name);
     free(series);
 }
 
@@ -118,6 +119,8 @@ lxw_chart_free(lxw_chart *chart)
         free(chart->series_list);
     }
 
+    free(chart->title.name);
+
     free(chart);
 }
 
@@ -315,6 +318,15 @@ _chart_write_hole_size(lxw_chart *self)
     LXW_FREE_ATTRIBUTES();
 }
 
+/*
+ * Write the <a:t> element.
+ */
+STATIC void
+_chart_write_a_t(lxw_chart *self, char *name)
+{
+    lxw_xml_data_element(self->file, "a:t", name, NULL);
+}
+
 /*
  * Write the <a:endParaRPr> element.
  */
@@ -341,6 +353,41 @@ _chart_write_a_def_rpr(lxw_chart *self)
     lxw_xml_empty_tag(self->file, "a:defRPr", NULL);
 }
 
+/*
+ * Write the <a:rPr> element.
+ */
+STATIC void
+_chart_write_a_r_pr(lxw_chart *self)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+    char lang[] = "en-US";
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("lang", lang);
+
+    lxw_xml_empty_tag(self->file, "a:rPr", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
+/*
+ * Write the <a:r> element.
+ */
+STATIC void
+_chart_write_a_r(lxw_chart *self, char *name)
+{
+    lxw_xml_start_tag(self->file, "a:r", NULL);
+
+    /* Write the a:rPr element. */
+    _chart_write_a_r_pr(self);
+
+    /* Write the a:t element. */
+    _chart_write_a_t(self, name);
+
+    lxw_xml_end_tag(self->file, "a:r");
+}
+
 /*
  * Write the <a:pPr> element.
  */
@@ -364,6 +411,20 @@ _chart_write_a_p_pr(lxw_chart *self)
     LXW_FREE_ATTRIBUTES();
 }
 
+/*
+ * Write the <a:pPr> element.
+ */
+STATIC void
+_chart_write_a_p_pr_rich(lxw_chart *self)
+{
+    lxw_xml_start_tag(self->file, "a:pPr", NULL);
+
+    /* Write the a:defRPr element. */
+    _chart_write_a_def_rpr(self);
+
+    lxw_xml_end_tag(self->file, "a:pPr");
+}
+
 /*
  * Write the <a:p> element.
  */
@@ -381,6 +442,23 @@ _chart_write_a_p(lxw_chart *self)
     lxw_xml_end_tag(self->file, "a:p");
 }
 
+/*
+ * Write the <a:p> element.
+ */
+STATIC void
+_chart_write_a_p_rich(lxw_chart *self, char *name)
+{
+    lxw_xml_start_tag(self->file, "a:p", NULL);
+
+    /* Write the a:pPr element. */
+    _chart_write_a_p_pr_rich(self);
+
+    /* Write the a:r element. */
+    _chart_write_a_r(self, name);
+
+    lxw_xml_end_tag(self->file, "a:p");
+}
+
 /*
  * Write the <a:lstStyle> element.
  */
@@ -419,6 +497,74 @@ _chart_write_tx_pr(lxw_chart *self)
     lxw_xml_end_tag(self->file, "c:txPr");
 }
 
+/*
+ * Write the <c:rich> element.
+ */
+STATIC void
+_chart_write_rich(lxw_chart *self, char *name)
+{
+    lxw_xml_start_tag(self->file, "c:rich", NULL);
+
+    /* Write the a:bodyPr element. */
+    _chart_write_a_body_pr(self);
+
+    /* Write the a:lstStyle element. */
+    _chart_write_a_lst_style(self);
+
+    /* Write the a:p element. */
+    _chart_write_a_p_rich(self, name);
+
+    lxw_xml_end_tag(self->file, "c:rich");
+}
+
+/*
+ * Write the <c:tx> element.
+ */
+STATIC void
+_chart_write_tx_rich(lxw_chart *self, char *name)
+{
+    lxw_xml_start_tag(self->file, "c:tx", NULL);
+
+    /* Write the c:rich element. */
+    _chart_write_rich(self, name);
+
+    lxw_xml_end_tag(self->file, "c:tx");
+}
+
+/*
+ * Write the <c:title> element for rich strings.
+ */
+STATIC void
+_chart_write_title_rich(lxw_chart *self)
+{
+    lxw_xml_start_tag(self->file, "c:title", NULL);
+
+    /* Write the c:tx element. */
+    _chart_write_tx_rich(self, self->title.name);
+
+    /* Write the c:layout element. */
+    _chart_write_layout(self);
+
+    lxw_xml_end_tag(self->file, "c:title");
+}
+
+/*
+ * Write the <c:autoTitleDeleted> element.
+ */
+STATIC void
+_chart_write_auto_title_deleted(lxw_chart *self)
+{
+    struct xml_attribute_list attributes;
+    struct xml_attribute *attribute;
+
+    LXW_INIT_ATTRIBUTES();
+    LXW_PUSH_ATTRIBUTES_STR("val", "1");
+
+    lxw_xml_empty_tag(self->file, "c:autoTitleDeleted", &attributes);
+
+    LXW_FREE_ATTRIBUTES();
+}
+
 /*
  * Write the <c:idx> element.
  */
@@ -550,7 +696,7 @@ _chart_write_pt_count(lxw_chart *self, uint16_t num_data_points)
  * Write the <c:v> element.
  */
 STATIC void
-_chart_write_v(lxw_chart *self, double number)
+_chart_write_v_num(lxw_chart *self, double number)
 {
     char data[LXW_ATTR_32];
 
@@ -559,6 +705,41 @@ _chart_write_v(lxw_chart *self, double number)
     lxw_xml_data_element(self->file, "c:v", data, NULL);
 }
 
+/*
+ * Write the <c:v> element.
+ */
+STATIC void
+_chart_write_v_str(lxw_chart *self, char *str)
+{
+    lxw_xml_data_element(self->file, "c:v", str, NULL);
+}
+
+/*
+ * Write the <c:tx> element.
+ */
+STATIC void
+_chart_write_tx(lxw_chart *self, char *name)
+{
+    lxw_xml_start_tag(self->file, "c:tx", NULL);
+
+    /* Write the c:v element. */
+    _chart_write_v_str(self, name);
+
+    lxw_xml_end_tag(self->file, "c:tx");
+}
+
+/*
+ * Write the series name.
+ */
+STATIC void
+_chart_write_series_name(lxw_chart *self, lxw_chart_series *series)
+{
+    if (series->name) {
+        /* Write the c:tx element. */
+        _chart_write_tx(self, series->name);
+    }
+}
+
 /*
  * Write the <c:pt> element.
  */
@@ -574,7 +755,7 @@ _chart_write_pt(lxw_chart *self, uint16_t index, double number)
     lxw_xml_start_tag(self->file, "c:pt", &attributes);
 
     /* Write the c:v element. */
-    _chart_write_v(self, number);
+    _chart_write_v_num(self, number);
 
     lxw_xml_end_tag(self->file, "c:pt");
 
@@ -594,7 +775,7 @@ _chart_write_format_code(lxw_chart *self)
  * Write the <c:majorTickMark> element.
  */
 STATIC void
-_chart_write_major_tick_mark(lxw_chart *self, lxw_axis *axis)
+_chart_write_major_tick_mark(lxw_chart *self, lxw_chart_axis *axis)
 {
     struct xml_attribute_list attributes;
     struct xml_attribute *attribute;
@@ -847,6 +1028,9 @@ _chart_write_ser(lxw_chart *self, lxw_chart_series *series)
     /* Write the c:order element. */
     _chart_write_order(self, index);
 
+    /* Write the series name. */
+    _chart_write_series_name(self, series);
+
     /* Write the c:marker element. */
     _chart_write_marker(self);
 
@@ -1070,7 +1254,7 @@ _chart_write_lbl_offset(lxw_chart *self)
  * Write the <c:majorGridlines> element.
  */
 STATIC void
-_chart_write_major_gridlines(lxw_chart *self, lxw_axis *axis)
+_chart_write_major_gridlines(lxw_chart *self, lxw_chart_axis *axis)
 {
 
     if (axis->default_major_gridlines)
@@ -1081,7 +1265,7 @@ _chart_write_major_gridlines(lxw_chart *self, lxw_axis *axis)
  * Write the <c:numFmt> element.
  */
 STATIC void
-_chart_write_number_format(lxw_chart *self, lxw_axis *axis)
+_chart_write_number_format(lxw_chart *self, lxw_chart_axis *axis)
 {
     struct xml_attribute_list attributes;
     struct xml_attribute *attribute;
@@ -1773,6 +1957,25 @@ _chart_write_plot_area(lxw_chart *self)
 
 }
 
+/*
+ * Write the <c:title> element.
+ */
+STATIC void
+_chart_write_title(lxw_chart *self)
+{
+    if (self->title.none) {
+        /* Write the c:autoTitleDeleted element. */
+        _chart_write_auto_title_deleted(self);
+    }
+    else {
+
+        if (self->title.name) {
+            /* Write the c:title element. */
+            _chart_write_title_rich(self);
+        }
+    }
+}
+
 /*
  * Write the <c:chart> element.
  */
@@ -1781,6 +1984,9 @@ _chart_write_chart(lxw_chart *self)
 {
     lxw_xml_start_tag(self->file, "c:chart", NULL);
 
+    /* Write the c:title element. */
+    _chart_write_title(self);
+
     /* Write the c:plotArea element. */
     _chart_write_plot_area(self);
 
@@ -1946,6 +2152,15 @@ mem_error:
     return NULL;
 }
 
+/*
+ * Set a user defined name for a seies.
+ */
+void
+chart_set_series_name(lxw_chart_series *series, char *name)
+{
+    series->name = lxw_strdup(name);
+}
+
 /*
  * Set on of the 48 built-in Excel chart styles.
  */
@@ -1959,6 +2174,16 @@ chart_set_style(lxw_chart *self, uint8_t style_id)
     self->style_id = style_id;
 }
 
+/*
+ * Set the properties of the chart title.
+ */
+void
+chart_set_title(lxw_chart *self, lxw_chart_title *title)
+{
+    self->title.none = title->none;
+    self->title.name = lxw_strdup(title->name);
+}
+
 /*
  * Set the Pie/Doughnut chart rotation: the angle of the first slice.
  */

test/functional/src/test_chart_title01.c

@@ -0,0 +1,46 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_title01.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_COLUMN);
+
+    lxw_chart_series *series;
+    lxw_chart_title title = {.none = LXW_TRUE};
+
+    /* For testing, copy the randomly generated axis ids in the target file. */
+    chart->axis_id_1 = 46165376;
+    chart->axis_id_2 = 54462720;
+
+    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);
+
+    series = chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$5");
+
+    chart_set_title(chart, &title);
+    chart_set_series_name(series, "Foo");
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_chart_title02.c

@@ -0,0 +1,44 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_chart_title02.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+    lxw_chart     *chart     = workbook_add_chart(workbook, LXW_CHART_COLUMN);
+
+    lxw_chart_title title = {.name = "Title!"};
+
+    /* For testing, copy the randomly generated axis ids in the target file. */
+    chart->axis_id_1 = 73655040;
+    chart->axis_id_2 = 73656576;
+
+    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);
+
+    chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$5");
+
+    chart_set_title(chart, &title);
+
+    worksheet_insert_chart(worksheet, CELL("E9"), chart);
+
+    return workbook_close(workbook);
+}

test/functional/test_chart_title.py

@@ -0,0 +1,21 @@
+###############################################################################
+#
+# Tests for libxlsxwriter.
+#
+# Copyright 2014-2016, 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_title01(self):
+        self.run_exe_test('test_chart_title01')
+
+    def test_chart_title02(self):
+        self.run_exe_test('test_chart_title02')
+