xlsxwriter 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af3bca200673e0730a5a147c1cafcf9707cbc995
-  data.tar.gz: 980e27d4f2291b26c2d44e2991d9b8c551cadc84
+SHA256:
+  metadata.gz: 495f1673b10c6db9e10fd486caff1f1c15810545bdd555309a4b6b124613938c
+  data.tar.gz: 1a49cf8826cb02d3257f44d8ec0899144d69b23af6baa5e1ef3c1addc657d6db
 SHA512:
-  metadata.gz: 4ff2da6747e509ca895278a8b26a3b0b4a8f595a61d33eb27ac96e32923eed36a88a786a9f0ba7d378973f01f4f7a422fb5947bd5fd8c82a559ef557a574eb60
-  data.tar.gz: 9e2178de081464fa5b6650850d8af0b750d7258c5bea6a1b9c11d325f5c553e7ea5d2a3ad339f66344eb3ac1ae17f765a1fe4b2eb2a3f3fef11f6d3c8a3eebf5
+  metadata.gz: ac2482347738c6009bc2ed51a0301d71877327d1e921035eb775f2fb5eec8d2330164a6b52075f0e0688ff33e00231b3bde47e2b5d140b044fef0e2ab6a27fca
+  data.tar.gz: 94d1339afa70ee9baf34a22b04481b4be6b6a6ab478cf3b7f9f7ffe8cd09831182f2ac042d65942d90a9c77e616e9f9b01b5cdd6dfb021f6fb6a9f760d023e1f

data/ext/xlsxwriter/libxlsxwriter/License.txt

@@ -4,7 +4,7 @@
 
 Libxlsxwriter is released under a FreeBSD license:
 
-    Copyright 2014-2017, John McNamara <jmcnamara@cpan.org>
+    Copyright 2014-2018, John McNamara <jmcnamara@cpan.org>
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without

data/ext/xlsxwriter/libxlsxwriter/Makefile

@@ -2,7 +2,7 @@
 #
 # Makefile for libxlsxwriter library.
 #
-# Copyright 2014-2017, John McNamara, jmcnamara@cpan.org
+# Copyright 2014-2018, John McNamara, jmcnamara@cpan.org
 #
 
 # Keep the output quiet by default.

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -18,6 +18,6 @@
 #include "xlsxwriter/format.h"
 #include "xlsxwriter/utility.h"
 
-#define LXW_VERSION "0.7.5"
+#define LXW_VERSION "0.7.7"
 
 #endif /* __LXW_XLSXWRITER_H__ */

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/app.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * app - A libxlsxwriter library for creating Excel XLSX app files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/chart.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * chart - A libxlsxwriter library for creating Excel XLSX chart files.
  *
@@ -464,6 +464,17 @@ typedef enum lxw_chart_label_separator {
     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,
@@ -613,7 +624,7 @@ typedef struct lxw_chart_line {
     /** The line dash type. See #lxw_chart_line_dash_type. */
     uint8_t dash_type;
 
-    /* Transparency for lines isn't generally useful. Undocumented for now. */
+    /** Set the transparency of the line. 0 - 100. Default 0. */
     uint8_t transparency;
 
     /* Members for internal use only. */
@@ -692,10 +703,17 @@ typedef struct lxw_chart_font {
     /** The chart font color. See @ref working_with_colors. */
     lxw_color_t color;
 
-    /* Members for internal use only. */
+    /** 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;
@@ -808,6 +826,17 @@ typedef enum lxw_chart_error_bar_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.
  */
@@ -2009,6 +2038,46 @@ void chart_series_set_trendline_name(lxw_chart_series *series,
  */
 void chart_series_set_trendline_line(lxw_chart_series *series,
                                      lxw_chart_line *line);
+/**
+ * @brief           Get a pointer to X or Y error bars from a chart series.
+ *
+ * @param series    A series object created via `chart_add_series()`.
+ * @param axis_type The axis type (X or Y): #lxw_chart_error_bar_axis.
+ *
+ * The `%chart_series_get_error_bars()` function returns a pointer to the
+ * error bars of a series based on the type of #lxw_chart_error_bar_axis:
+ *
+ * @code
+ *     lxw_series_error_bars *x_error_bars;
+ *     lxw_series_error_bars *y_error_bars;
+ *
+ *     x_error_bars = chart_series_get_error_bars(series, LXW_CHART_ERROR_BAR_AXIS_X);
+ *     y_error_bars = chart_series_get_error_bars(series, LXW_CHART_ERROR_BAR_AXIS_Y);
+ *
+ *     // Use the error bar pointers.
+ *     chart_series_set_error_bars(x_error_bars,
+ *                                 LXW_CHART_ERROR_BAR_TYPE_STD_DEV, 1);
+ *
+ *     chart_series_set_error_bars(y_error_bars,
+ *                                 LXW_CHART_ERROR_BAR_TYPE_STD_ERROR, 0);
+ * @endcode
+ *
+ * Note, the series error bars can also be accessed directly:
+ *
+ * @code
+ *     // Equivalent to the above example, without function calls.
+ *     chart_series_set_error_bars(series->x_error_bars,
+ *                                 LXW_CHART_ERROR_BAR_TYPE_STD_DEV, 1);
+ *
+ *     chart_series_set_error_bars(series->y_error_bars,
+ *                                 LXW_CHART_ERROR_BAR_TYPE_STD_ERROR, 0);
+ * @endcode
+ *
+ * @return Pointer to the series error bars, or NULL if not found.
+ */
+
+lxw_series_error_bars *chart_series_get_error_bars(lxw_chart_series *series, lxw_chart_error_bar_axis
+                                                   axis_type);
 
 /**
  * Set the X or Y error bars for a chart series.
@@ -2072,7 +2141,7 @@ void chart_series_set_error_bars(lxw_series_error_bars *error_bars,
  *        series.
  *
  * @param error_bars A pointer to the series X or Y error bars.
- * @param direction  The bar direction: #lxw_chart_error_bar_direction .
+ * @param direction  The bar direction: #lxw_chart_error_bar_direction.
  *
  * The `%chart_series_set_error_bars_direction()` function sets the
  * direction of the error bars:
@@ -2154,6 +2223,37 @@ void chart_series_set_error_bars_endcap(lxw_series_error_bars *error_bars,
 void chart_series_set_error_bars_line(lxw_series_error_bars *error_bars,
                                       lxw_chart_line *line);
 
+/**
+ * @brief           Get an axis pointer from a chart.
+ *
+ * @param chart     Pointer to a lxw_chart instance to be configured.
+ * @param axis_type The axis type (X or Y): #lxw_chart_axis_type.
+ *
+ * The `%chart_axis_get()` function returns a pointer to a chart axis based
+ * on the  #lxw_chart_axis_type:
+ *
+ * @code
+ *     lxw_chart_axis *x_axis = chart_axis_get(chart, LXW_CHART_AXIS_TYPE_X);
+ *     lxw_chart_axis *y_axis = chart_axis_get(chart, LXW_CHART_AXIS_TYPE_Y);
+ *
+ *     // Use the axis pointer in other functions.
+ *     chart_axis_major_gridlines_set_visible(x_axis, LXW_TRUE);
+ *     chart_axis_major_gridlines_set_visible(y_axis, LXW_TRUE);
+ * @endcode
+ *
+ * Note, the axis pointer can also be accessed directly:
+ *
+ * @code
+ *     // Equivalent to the above example, without function calls.
+ *     chart_axis_major_gridlines_set_visible(chart->x_axis, LXW_TRUE);
+ *     chart_axis_major_gridlines_set_visible(chart->y_axis, LXW_TRUE);
+ * @endcode
+ *
+ * @return Pointer to the chart axis, or NULL if not found.
+ */
+lxw_chart_axis *chart_axis_get(lxw_chart *chart,
+                               lxw_chart_axis_type axis_type);
+
 /**
  * @brief Set the name caption of the an axis.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/common.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -9,7 +9,7 @@
  *
  * @brief Common functions and defines for the libxlsxwriter library.
  *
- * <!-- Copyright 2014-2017, John McNamara, jmcnamara@cpan.org -->
+ * <!-- Copyright 2014-2018, John McNamara, jmcnamara@cpan.org -->
  *
  */
 #ifndef __LXW_COMMON_H__
@@ -268,9 +268,14 @@ enum lxw_custom_property_types {
                                (((n) & 0xFF0000)   >>  8) | \
                                (((n) & 0xFF000000) >> 24))
 #define LXW_UINT16_NETWORK(n) ((((n) & 0x00FF) << 8) | (((n) & 0xFF00) >> 8))
+#define LXW_UINT32_HOST(n)    (n)
 #else
 #define LXW_UINT32_NETWORK(n) (n)
 #define LXW_UINT16_NETWORK(n) (n)
+#define LXW_UINT32_HOST(n)    ((((n) & 0xFF)       << 24) | \
+                               (((n) & 0xFF00)     <<  8) | \
+                               (((n) & 0xFF0000)   >>  8) | \
+                               (((n) & 0xFF000000) >> 24))
 #endif
 
 /* *INDENT-OFF* */

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/content_types.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * content_types - A libxlsxwriter library for creating Excel XLSX
  *                 content_types files.

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/core.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * core - A libxlsxwriter library for creating Excel XLSX core files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/custom.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * custom - A libxlsxwriter library for creating Excel custom property files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/drawing.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * drawing - A libxlsxwriter library for creating Excel XLSX drawing files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/format.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/hash_table.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * hash_table - Hash table functions for libxlsxwriter.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/packager.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * packager - A libxlsxwriter library for creating Excel XLSX packager files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/relationships.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * relationships - A libxlsxwriter library for creating Excel XLSX
  *                 relationships files.

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/shared_strings.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * shared_strings - A libxlsxwriter library for creating Excel XLSX
  *                  sst files.

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/styles.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * styles - A libxlsxwriter library for creating Excel XLSX styles files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/theme.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * theme - A libxlsxwriter library for creating Excel XLSX theme files.
  *

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/utility.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -9,7 +9,7 @@
  *
  * @brief Utility functions for libxlsxwriter.
  *
- * <!-- Copyright 2014-2017, John McNamara, jmcnamara@cpan.org -->
+ * <!-- Copyright 2014-2018, John McNamara, jmcnamara@cpan.org -->
  *
  */
 
@@ -18,6 +18,7 @@
 
 #include <stdint.h>
 #include "common.h"
+#include "xmlwriter.h"
 
 /**
  * @brief Convert an Excel `A1` cell string into a `(row, col)` pair.
@@ -153,9 +154,13 @@ void lxw_str_tolower(char *str);
 
 FILE *lxw_tmpfile(char *tmpdir);
 
-/* Declarations required for unit testing. */
-#ifdef TESTING
-
+/* Use a user defined function to format doubles in sprintf or else a simple
+ * macro (the default). */
+#ifdef USE_DOUBLE_FUNCTION
+int lxw_sprintf_dbl(char *data, double number);
+#else
+#define lxw_sprintf_dbl(data, number) \
+        lxw_snprintf(data, LXW_ATTR_32, "%.16g", number)
 #endif
 
 /* *INDENT-OFF* */

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/workbook.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/worksheet.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -267,12 +267,14 @@ STAILQ_HEAD(lxw_chart_data, lxw_image_options);
  * Options struct for the worksheet_set_column() and worksheet_set_row()
  * functions.
  *
- * It has the following members but currently only the `hidden` property is
- * supported:
+ * It has the following members:
  *
  * * `hidden`
  * * `level`
  * * `collapsed`
+ *
+ * The members of this struct are explained in @ref ww_outlines_grouping.
+ *
  */
 typedef struct lxw_row_col_options {
     /** Hide the row/column */
@@ -696,6 +698,9 @@ typedef struct lxw_worksheet {
     uint8_t orientation;
     uint8_t outline_changed;
     uint8_t outline_on;
+    uint8_t outline_style;
+    uint8_t outline_below;
+    uint8_t outline_right;
     uint8_t page_order;
     uint8_t page_setup_changed;
     uint8_t page_view;
@@ -725,6 +730,8 @@ typedef struct lxw_worksheet {
     uint32_t default_col_pixels;
     uint8_t default_row_zeroed;
     uint8_t default_row_set;
+    uint8_t outline_row_level;
+    uint8_t outline_col_level;
 
     uint8_t header_footer_changed;
     char header[LXW_HEADER_FOOTER_MAX];
@@ -959,6 +966,7 @@ lxw_error worksheet_write_string(lxw_worksheet *worksheet,
  *     worksheet_write_formula(worksheet, 1, 0, "=SUM(1; 2; 3)", NULL);
  * @endcode
  *
+ * See also @ref working_with_formulas.
  */
 lxw_error worksheet_write_formula(lxw_worksheet *worksheet,
                                   lxw_row_t row,
@@ -1172,7 +1180,7 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * @endcode
  *
  *
- * Alternatively, you can use Windows style forward slashes. These are
+ * Alternatively, you can use Unix style forward slashes. These are
  * translated internally to backslashes:
  *
  * @code
@@ -1289,6 +1297,7 @@ lxw_error worksheet_write_blank(lxw_worksheet *worksheet,
  * worksheet_write_formula() function is the recommended way of writing
  * formulas.
  *
+ * See also @ref working_with_formulas.
  */
 lxw_error worksheet_write_formula_num(lxw_worksheet *worksheet,
                                       lxw_row_t row,
@@ -1364,7 +1373,7 @@ lxw_error worksheet_set_row(lxw_worksheet *worksheet,
  *  `worksheet_set_row()` with an additional `options` parameter.
  *
  * The `options` parameter is a #lxw_row_col_options struct. It has the
- * following members but currently only the `hidden` property is supported:
+ * following members:
  *
  * - `hidden`
  * - `level`
@@ -1374,12 +1383,41 @@ lxw_error worksheet_set_row(lxw_worksheet *worksheet,
  * example, to hide intermediary steps in a complicated calculation:
  *
  * @code
- *     lxw_row_col_options options = {.hidden = 1, .level = 0, .collapsed = 0};
+ *     lxw_row_col_options options1 = {.hidden = 1, .level = 0, .collapsed = 0};
+ *
+ *     // Hide the fourth and fifth (zero indexed) rows.
+ *     worksheet_set_row_opt(worksheet, 3,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 4,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
  *
- *     // Hide the fourth row.
- *     worksheet_set_row(worksheet, 3, 20, NULL, &options);
  * @endcode
  *
+ * @image html hide_row_col2.png
+ *
+ * The `"hidden"`, `"level"`,  and `"collapsed"`, options can also be used to
+ * create Outlines and Grouping. See @ref working_with_outlines.
+ *
+ * @code
+ *     // The option structs with the outline level set.
+ *     lxw_row_col_options options1 = {.hidden = 0, .level = 2, .collapsed = 0};
+ *     lxw_row_col_options options2 = {.hidden = 0, .level = 1, .collapsed = 0};
+ *
+ *
+ *     // Set the row options with the outline level.
+ *     worksheet_set_row_opt(worksheet, 1,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 2,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 3,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 4,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 5,  LXW_DEF_ROW_HEIGHT, NULL, &options2);
+ *
+ *     worksheet_set_row_opt(worksheet, 6,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 7,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 8,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 9,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 10, LXW_DEF_ROW_HEIGHT, NULL, &options2);
+ * @endcode
+ *
+ * @image html outline1.png
+ *
  */
 lxw_error worksheet_set_row_opt(lxw_worksheet *worksheet,
                                 lxw_row_t row,
@@ -1487,36 +1525,48 @@ lxw_error worksheet_set_column(lxw_worksheet *worksheet,
                                lxw_col_t last_col,
                                double width, lxw_format *format);
 
- /**
-  * @brief Set the properties for one or more columns of cells with options.
-  *
-  * @param worksheet Pointer to a lxw_worksheet instance to be updated.
-  * @param first_col The zero indexed first column.
-  * @param last_col  The zero indexed last column.
-  * @param width     The width of the column(s).
-  * @param format    A pointer to a Format instance or NULL.
-  * @param options   Optional row parameters: hidden, level, collapsed.
-  *
-  * The `%worksheet_set_column_opt()` function  is the same as
-  * `worksheet_set_column()` with an additional `options` parameter.
-  *
-  * The `options` parameter is a #lxw_row_col_options struct. It has the
-  * following members but currently only the `hidden` property is supported:
-  *
-  * - `hidden`
-  * - `level`
-  * - `collapsed`
-  *
-  * The `"hidden"` option is used to hide a column. This can be used, for
-  * example, to hide intermediary steps in a complicated calculation:
-  *
-  * @code
-  *     lxw_row_col_options options = {.hidden = 1, .level = 0, .collapsed = 0};
-  *
-  *     worksheet_set_column_opt(worksheet, COLS("A:A"), 8.43, NULL, &options);
-  * @endcode
-  *
-  */
+/**
+ * @brief Set the properties for one or more columns of cells with options.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance to be updated.
+ * @param first_col The zero indexed first column.
+ * @param last_col  The zero indexed last column.
+ * @param width     The width of the column(s).
+ * @param format    A pointer to a Format instance or NULL.
+ * @param options   Optional row parameters: hidden, level, collapsed.
+ *
+ * The `%worksheet_set_column_opt()` function  is the same as
+ * `worksheet_set_column()` with an additional `options` parameter.
+ *
+ * The `options` parameter is a #lxw_row_col_options struct. It has the
+ * following members:
+ *
+ * - `hidden`
+ * - `level`
+ * - `collapsed`
+ *
+ * The `"hidden"` option is used to hide a column. This can be used, for
+ * example, to hide intermediary steps in a complicated calculation:
+ *
+ * @code
+ *     lxw_row_col_options options1 = {.hidden = 1, .level = 0, .collapsed = 0};
+ *
+ *     worksheet_set_column_opt(worksheet, COLS("D:E"),  LXW_DEF_COL_WIDTH, NULL, &options1);
+ * @endcode
+ *
+ * @image html hide_row_col3.png
+ *
+ * The `"hidden"`, `"level"`,  and `"collapsed"`, options can also be used to
+ * create Outlines and Grouping. See @ref working_with_outlines.
+ *
+ * @code
+ *     lxw_row_col_options options1 = {.hidden = 0, .level = 1, .collapsed = 0};
+ *
+ *     worksheet_set_column_opt(worksheet, COLS("B:G"),  5, NULL, &options1);
+ * @endcode
+ *
+ * @image html outline8.png
+ */
 lxw_error worksheet_set_column_opt(lxw_worksheet *worksheet,
                                    lxw_col_t first_col,
                                    lxw_col_t last_col,
@@ -2932,6 +2982,54 @@ void worksheet_set_tab_color(lxw_worksheet *worksheet, lxw_color_t color);
 void worksheet_protect(lxw_worksheet *worksheet, const char *password,
                        lxw_protection *options);
 
+/**
+ * @brief Set the Outline and Grouping display properties.
+ *
+ * @param worksheet      Pointer to a lxw_worksheet instance to be updated.
+ * @param visible        Outlines are visible. Optional, defaults to True.
+ * @param symbols_below  Show row outline symbols below the outline bar.
+ * @param symbols_right  Show column outline symbols to the right of outline.
+ * @param auto_style     Use Automatic outline style.
+ *
+ * The `%worksheet_outline_settings()` method is used to control the
+ * appearance of outlines in Excel. Outlines are described the section on
+ * @ref working_with_outlines.
+ *
+ * The `visible` parameter is used to control whether or not outlines are
+ * visible. Setting this parameter to False will cause all outlines on the
+ * worksheet to be hidden. They can be un-hidden in Excel by means of the
+ * "Show Outline Symbols" command button. The default Excel setting is True
+ * for visible outlines.
+ *
+ * The `symbols_below` parameter is used to control whether the row outline
+ * symbol will appear above or below the outline level bar. The default Excel
+ * setting is True for symbols to appear below the outline level bar.
+ *
+ * The `symbols_right` parameter is used to control whether the column outline
+ * symbol will appear to the left or the right of the outline level bar. The
+ * default Excel setting is True for symbols to appear to the right of the
+ * outline level bar.
+ *
+ * The `auto_style` parameter is used to control whether the automatic outline
+ * generator in Excel uses automatic styles when creating an outline. This has
+ * no effect on a file generated by XlsxWriter but it does have an effect on
+ * how the worksheet behaves after it is created. The default Excel setting is
+ * False for "Automatic Styles" to be turned off.
+ *
+ * The default settings for all of these parameters in libxlsxwriter
+ * correspond to Excel's default parameters and are shown below:
+ *
+ * @code
+ *     worksheet_outline_settings(worksheet1, LXW_TRUE, LXW_TRUE, LXW_TRUE, LXW_FALSE);
+ * @endcode
+ *
+ * The worksheet parameters controlled by `worksheet_outline_settings()` are
+ * rarely used.
+ */
+void worksheet_outline_settings(lxw_worksheet *worksheet, uint8_t visible,
+                                uint8_t symbols_below, uint8_t symbols_right,
+                                uint8_t auto_style);
+
 /**
  * @brief Set the default row properties.
  *