fast_excel 0.2.6 → 0.3.0

data/libxlsxwriter/.gitignore

@@ -20,6 +20,7 @@ TAGS
 *.bak
 !test/functional/xlsx_files/*.xlsx
 *.pyc
+.pytest_cache/
 .cproject
 .project
 .pydevproject

data/libxlsxwriter/.indent.pro

@@ -50,6 +50,7 @@
 -T lxw_chart
 -T lxw_chart_axis
 -T lxw_chart_axis_display_unit
+-T lxw_chart_axis_label_alignment
 -T lxw_chart_axis_label_position
 -T lxw_chart_axis_tick_mark
 -T lxw_chart_axis_tick_position
@@ -77,6 +78,8 @@
 -T lxw_chart_title
 -T lxw_chart_trendline_type
 -T lxw_chart_type
+-T lxw_chartsheet
+-T lxw_chartsheet_name
 -T lxw_col_options
 -T lxw_col_t
 -T lxw_color_t
@@ -110,6 +113,7 @@
 -T lxw_relationships
 -T lxw_repeat_cols
 -T lxw_repeat_rows
+-T lxw_rich_string_tuple
 -T lxw_row
 -T lxw_row_col_options
 -T lxw_row_t
@@ -117,6 +121,7 @@
 -T lxw_series_data_point
 -T lxw_series_error_bars
 -T lxw_series_range
+-T lxw_sheet
 -T lxw_sst
 -T lxw_styles
 -T lxw_theme

data/libxlsxwriter/CMakeLists.txt

@@ -216,16 +216,6 @@ target_include_directories(${PROJECT_NAME}
     PUBLIC include include/xlsxwriter
 )
 
-if(MSVC)
-    if (NOT BUILD_SHARED_LIBS)
-        add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
-            COMMAND ${CMAKE_COMMAND} -E rename
-            ${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pdb
-            $<TARGET_FILE_DIR:${PROJECT_NAME}>/${PROJECT_NAME}.pdb
-        )
-    endif()
-endif()
-
 # TESTS
 # -----
 
@@ -329,7 +319,7 @@ if(MSVC)
         RUNTIME DESTINATION "bin/${MSVC_FOLDER_PREFIX}/\${CMAKE_INSTALL_CONFIG_NAME}"
     )
     if (NOT BUILD_SHARED_LIBS)
-        install(FILES $<TARGET_FILE_DIR:${PROJECT_NAME}>/${PROJECT_NAME}.pdb
+        install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME}.pdb
             DESTINATION "lib/${MSVC_FOLDER_PREFIX}/\${CMAKE_INSTALL_CONFIG_NAME}"
         )
     endif()

data/libxlsxwriter/CONTRIBUTING.md

@@ -24,7 +24,7 @@ the `xlsxwriter.h` header file or by adding the following to your program:
 
 int main() {
 
-    printf("Libxlsxwriter version = %s\n", LXW_VERSION);
+    printf("Libxlsxwriter version = %s\n", lxw_version());
 
     return 0;
 }

data/libxlsxwriter/Changes.txt

@@ -1,6 +1,90 @@
 /**
 @page changes Changes
 
+## 0.8.6 April 7 2019
+
+- Fixed issue where images that started in hidden rows/columns weren't placed
+  correctly in the worksheet.
+
+- Fixed the mime-type reported by system `file(1)`. The mime-type reported
+  by "file --mime-type"/magic was incorrect for XlsxWriter files since it
+  expected the `[Content_types]` to be the first file in the zip container.
+
+
+## 0.8.5 February 10 2019
+
+- Fix compile-time warnings with strict prototypes enabled.
+  Issue [#208][gh_208].
+
+  [gh_208]: https://github.com/jmcnamara/libxlsxwriter/issues/208
+
+- Make py.test name configurable.
+  Pull request [#206][gh_206].
+
+  [gh_206]: https://github.com/jmcnamara/libxlsxwriter/pull/206
+
+
+## 0.8.4 November 10 2018
+
+- Fix for issue when hashing number formats.
+  Issue [#203][gh_203].
+
+  [gh_203]: https://github.com/jmcnamara/libxlsxwriter/issues/203
+
+
+## 0.8.3 October 1 2018
+
+- Added `worksheet_write_rich_string()` function to allow writing of
+  multi-format rich strings. See @ref rich_strings.c
+  Feature request [#37][gh_37].
+
+  [gh_37]: https://github.com/jmcnamara/libxlsxwriter/issues/37
+
+
+## 0.8.2 September 16 2018
+
+- Added new chartsheet functionality: `chartsheet_set_tab_color()`, and
+  `chartsheet_set_zoom()`.
+
+
+## 0.8.1 September 15 2018
+
+- Fix for chartsheet and worksheet ordering issue.
+
+- Added new chartsheet functionality: `chartsheet_protect()`,
+  `chartsheet_hide()`, `chartsheet_select()` and
+  `chartsheet_set_first_sheet()`.
+
+
+## 0.8.0 September 12 2018
+
+- Added chartsheet support. A chartsheet is a type of worksheet that only
+  contains a chart. See the @ref chartsheet.h "Chartsheet" object and @ref
+  chartsheet.c.
+
+
+## 0.7.9 September 1 2018
+
+- Added `chart_axis_set_label_align()` function to set the alignment of chart
+  category axis labels.
+  Feature request [#186][gh_186].
+
+  [gh_186]: https://github.com/jmcnamara/libxlsxwriter/issues/186
+
+- Added `lxw_version()` function to get the library version.
+  Feature request [#194][gh_194].
+
+  [gh_194]: https://github.com/jmcnamara/libxlsxwriter/pull/194
+
+
+## 0.7.8 August 30 2018
+
+- Added `worksheet_insert_image_buffer()` function to insert images from
+  memory buffers. See @ref image_buffer.c.
+  Feature request [#125][gh_125].
+
+  [gh_125]: https://github.com/jmcnamara/libxlsxwriter/issues/125
+
 
 ## 0.7.7 May 16 2018
 

data/libxlsxwriter/LICENSE.txt

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

data/libxlsxwriter/Makefile

@@ -2,7 +2,7 @@
 #
 # Makefile for libxlsxwriter library.
 #
-# Copyright 2014-2018, John McNamara, jmcnamara@cpan.org
+# Copyright 2014-2019, John McNamara, jmcnamara@cpan.org
 #
 
 # Keep the output quiet by default.
@@ -13,6 +13,8 @@ endif
 
 INSTALL_DIR ?= /usr/local
 
+PYTEST ?= py.test
+
 .PHONY: docs tags examples
 
 # Build the libs.
@@ -32,9 +34,9 @@ examples :
 # Clean src and test directories.
 clean :
 	$(Q)$(MAKE) clean -C src
-	$(Q)$(MAKE) clean -C test/unit
-	$(Q)$(MAKE) clean -C test/functional/src
-	$(Q)$(MAKE) clean -C examples
+	# $(Q)$(MAKE) clean -C test/unit
+	# $(Q)$(MAKE) clean -C test/functional/src
+	# $(Q)$(MAKE) clean -C examples
 	$(Q)rm -rf docs/html
 	$(Q)rm -rf test/functional/__pycache__
 	$(Q)rm -f  test/functional/*.pyc
@@ -58,7 +60,7 @@ test_const : all
 # Run the functional tests.
 test_functional : all
 	$(Q)$(MAKE) -C test/functional/src
-	$(Q)py.test test/functional -v
+	$(Q)$(PYTEST) test/functional -v
 
 # Run all tests.
 test_unit :

data/libxlsxwriter/Readme.md

@@ -59,7 +59,7 @@ int main() {
     /* Text with formatting. */
     worksheet_write_string(worksheet, 1, 0, "World", format);
 
-    /* Writer some numbers. */
+    /* Write some numbers. */
     worksheet_write_number(worksheet, 2, 0, 123,     NULL);
     worksheet_write_number(worksheet, 3, 0, 123.456, NULL);
 

data/libxlsxwriter/cocoapods/libxlsxwriter-umbrella.h

@@ -3,6 +3,7 @@
 #import "../xlsxwriter.h"
 #import "app.h"
 #import "chart.h"
+#import "chartsheet.h"
 #import "common.h"
 #import "content_types.h"
 #import "core.h"

data/libxlsxwriter/include/xlsxwriter.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2019, 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.7"
+#define LXW_VERSION "0.8.6"
 
 #endif /* __LXW_XLSXWRITER_H__ */

data/libxlsxwriter/include/xlsxwriter/app.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * app - A libxlsxwriter library for creating Excel XLSX app files.
  *
@@ -56,7 +56,7 @@ extern "C" {
 #endif
 /* *INDENT-ON* */
 
-lxw_app *lxw_app_new();
+lxw_app *lxw_app_new(void);
 void lxw_app_free(lxw_app *app);
 void lxw_app_assemble_xml_file(lxw_app *self);
 void lxw_app_add_part_name(lxw_app *self, const char *name);

data/libxlsxwriter/include/xlsxwriter/chart.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2018, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  *
  * chart - A libxlsxwriter library for creating Excel XLSX chart files.
  *
@@ -172,11 +172,17 @@ typedef enum lxw_chart_legend_position {
     /** 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
+    LXW_CHART_LEGEND_OVERLAY_LEFT,
+
+    /** Chart legend overlaid at top right. */
+    LXW_CHART_LEGEND_OVERLAY_TOP_RIGHT
 } lxw_chart_legend_position;
 
 /**
@@ -523,6 +529,20 @@ typedef enum lxw_chart_axis_label_position {
     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.
  */
@@ -981,6 +1001,7 @@ typedef struct lxw_chart_axis {
     uint8_t axis_position;
     uint8_t position_axis;
     uint8_t label_position;
+    uint8_t label_align;
     uint8_t hidden;
     uint8_t reverse;
 
@@ -1048,6 +1069,7 @@ typedef struct lxw_chart {
     uint8_t in_use;
     uint8_t chart_group;
     uint8_t cat_has_num_fmt;
+    uint8_t is_chartsheet;
 
     uint8_t has_horiz_cat_axis;
     uint8_t has_horiz_val_axis;
@@ -1103,6 +1125,7 @@ typedef struct lxw_chart {
     lxw_chart_fill *down_bar_fill;
 
     uint8_t default_label_position;
+    uint8_t is_protected;
 
     STAILQ_ENTRY (lxw_chart) ordered_list_pointers;
     STAILQ_ENTRY (lxw_chart) list_pointers;
@@ -1284,7 +1307,7 @@ void chart_series_set_values(lxw_chart_series *series, const char *sheetname,
  * @code
  *     lxw_chart_series *series = chart_add_series(chart, NULL, "=Sheet1!$B$2:$B$7");
  *
- *     chart_series_set_name(series, "=Sheet1!$B1$1");
+ *     chart_series_set_name(series, "=Sheet1!$B$1");
  * @endcode
  *
  * See also the `chart_series_set_name_range()` function to see how to set the
@@ -2275,7 +2298,7 @@ lxw_chart_axis *chart_axis_get(lxw_chart *chart,
  * a cell in the workbook that contains the name:
  *
  * @code
- *     chart_axis_set_name(chart->x_axis, "=Sheet1!$B1$1");
+ *     chart_axis_set_name(chart->x_axis, "=Sheet1!$B$1");
  * @endcode
  *
  * See also the `chart_axis_set_name_range()` function to see how to set the
@@ -2567,7 +2590,7 @@ void chart_axis_set_position(lxw_chart_axis *axis, uint8_t position);
  *
  * @code
  *     chart_axis_set_label_position(chart->x_axis, LXW_CHART_AXIS_LABEL_POSITION_HIGH);
-       chart_axis_set_label_position(chart->y_axis, LXW_CHART_AXIS_LABEL_POSITION_HIGH);
+ *     chart_axis_set_label_position(chart->y_axis, LXW_CHART_AXIS_LABEL_POSITION_HIGH);
  * @endcode
  *
  * @image html chart_label_position2.png
@@ -2590,6 +2613,31 @@ void chart_axis_set_position(lxw_chart_axis *axis, uint8_t position);
  */
 void chart_axis_set_label_position(lxw_chart_axis *axis, uint8_t position);
 
+/**
+ * @brief Set the alignment of the axis labels.
+ *
+ * @param axis  A pointer to a chart #lxw_chart_axis object.
+ * @param align A #lxw_chart_axis_label_alignment value.
+ *
+ * Position the category axis labels for the chart. The labels are the
+ * numbers, or strings or dates, on the axis that indicate the categories
+ * of the axis.
+ *
+ * The allowable values:
+ *
+ * - #LXW_CHART_AXIS_LABEL_ALIGN_CENTER - Align label center (default).
+ * - #LXW_CHART_AXIS_LABEL_ALIGN_LEFT - Align label left.
+ * - #LXW_CHART_AXIS_LABEL_ALIGN_RIGHT - Align label right.
+ *
+ * @code
+ *     chart_axis_set_label_align(chart->x_axis, LXW_CHART_AXIS_LABEL_ALIGN_RIGHT);
+ * @endcode
+ *
+ * **Axis types**: This function is applicable to category axes only.
+ *                 See @ref ww_charts_axes.
+ */
+void chart_axis_set_label_align(lxw_chart_axis *axis, uint8_t align);
+
 /**
  * @brief Set the minimum value for a chart axis.
  *
@@ -2958,7 +3006,7 @@ void chart_axis_minor_gridlines_set_line(lxw_chart_axis *axis,
  * a cell in the workbook that contains the name:
  *
  * @code
- *     chart_title_set_name(chart, "=Sheet1!$B1$1");
+ *     chart_title_set_name(chart, "=Sheet1!$B$1");
  * @endcode
  *
  * See also the `chart_title_set_name_range()` function to see how to set the
@@ -3040,8 +3088,10 @@ void chart_title_off(lxw_chart *chart);
  *     LXW_CHART_LEGEND_LEFT
  *     LXW_CHART_LEGEND_TOP
  *     LXW_CHART_LEGEND_BOTTOM
+ *     LXW_CHART_LEGEND_TOP_RIGHT
  *     LXW_CHART_LEGEND_OVERLAY_RIGHT
  *     LXW_CHART_LEGEND_OVERLAY_LEFT
+ *     LXW_CHART_LEGEND_OVERLAY_TOP_RIGHT
  *
  * For example:
  *

data/libxlsxwriter/include/xlsxwriter/chartsheet.h

@@ -0,0 +1,544 @@
+/*
+ * libxlsxwriter
+ *
+ * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ *
+ * chartsheet - A libxlsxwriter library for creating Excel XLSX chartsheet files.
+ *
+ */
+
+/**
+ * @page chartsheet_page The Chartsheet object
+ *
+ * The Chartsheet object represents an Excel chartsheet, which is a type of
+ * worksheet that only contains a chart. The Chartsheet object handles
+ * operations such as adding a chart and setting the page layout.
+ *
+ * See @ref chartsheet.h for full details of the functionality.
+ *
+ * @file chartsheet.h
+ *
+ * @brief Functions related to adding data and formatting to a chartsheet.
+ *
+ * The Chartsheet object represents an Excel chartsheet. It handles operations
+ * such as adding a chart and setting the page layout.
+ *
+ * A Chartsheet object isn't created directly. Instead a chartsheet is created
+ * by calling the workbook_add_chartsheet() function from a Workbook object. A
+ * chartsheet object functions as a worksheet and not as a chart. In order to
+ * have it display data a #lxw_chart object must be created and added to the
+ * chartsheet:
+ *
+ * @code
+ *     #include "xlsxwriter.h"
+ *
+ *     int main() {
+ *
+ *         lxw_workbook   *workbook   = new_workbook("chartsheet.xlsx");
+ *         lxw_worksheet  *worksheet  = workbook_add_worksheet(workbook, NULL);
+ *         lxw_chartsheet *chartsheet = workbook_add_chartsheet(workbook, NULL);
+ *         lxw_chart      *chart      = workbook_add_chart(workbook, LXW_CHART_BAR);
+ *
+ *         //... Set up the chart.
+ *
+ *         // Add the chart to the chartsheet.
+ *         return workbook_close(workbook);
+ *
+ *     }
+ * @endcode
+ *
+ * @image html chartsheet.png
+ *
+ * The data for the chartsheet chart must be contained on a separate
+ * worksheet. That is why it is always created in conjunction with at least
+ * one data worksheet, as shown above.
+ */
+
+#ifndef __LXW_CHARTSHEET_H__
+#define __LXW_CHARTSHEET_H__
+
+#include <stdint.h>
+
+#include "common.h"
+#include "worksheet.h"
+#include "drawing.h"
+#include "utility.h"
+
+/**
+ * @brief Struct to represent an Excel chartsheet.
+ *
+ * The members of the lxw_chartsheet struct aren't modified directly. Instead
+ * the chartsheet properties are set by calling the functions shown in
+ * chartsheet.h.
+ */
+typedef struct lxw_chartsheet {
+
+    FILE *file;
+    lxw_worksheet *worksheet;
+    lxw_chart *chart;
+
+    struct lxw_protection protection;
+    uint8_t is_protected;
+
+    char *name;
+    char *quoted_name;
+    char *tmpdir;
+    uint32_t index;
+    uint8_t active;
+    uint8_t selected;
+    uint8_t hidden;
+    uint16_t *active_sheet;
+    uint16_t *first_sheet;
+    uint16_t rel_count;
+
+    STAILQ_ENTRY (lxw_chartsheet) list_pointers;
+
+} lxw_chartsheet;
+
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C" {
+#endif
+/* *INDENT-ON* */
+
+/**
+ * @brief Insert a chart object into a chartsheet.
+ *
+ * @param chartsheet   Pointer to a lxw_chartsheet instance to be updated.
+ * @param chart        A #lxw_chart object created via workbook_add_chart().
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%chartsheet_set_chart()` function can be used to insert a chart into a
+ * chartsheet. The chart object must be created first using the
+ * `workbook_add_chart()` function and configured using the @ref chart.h
+ * functions.
+ *
+ * @code
+ *     // Create the chartsheet.
+ *     lxw_chartsheet *chartsheet = workbook_add_chartsheet(workbook, NULL);
+ *
+ *     // Create a chart object.
+ *     lxw_chart *chart = workbook_add_chart(workbook, LXW_CHART_LINE);
+ *
+ *     // Add a data series to the chart.
+ *     chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$6");
+ *
+ *     // Insert the chart into the chartsheet.
+ *     chartsheet_set_chart(chartsheet, chart);
+ * @endcode
+ *
+ * @image html chartsheet2.png
+ *
+ * **Note:**
+ *
+ * A chart may only be inserted once into a chartsheet or a worksheet. If
+ * several similar charts are required then each one must be created
+ * separately.
+ *
+ */
+lxw_error chartsheet_set_chart(lxw_chartsheet *chartsheet, lxw_chart *chart);
+
+/* Not currently required since scale options aren't useful in a chartsheet. */
+lxw_error chartsheet_set_chart_opt(lxw_chartsheet *chartsheet,
+                                   lxw_chart *chart,
+                                   lxw_image_options *user_options);
+
+/**
+ * @brief Make a chartsheet the active, i.e., visible chartsheet.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ *
+ * The `%chartsheet_activate()` function is used to specify which chartsheet
+ * is initially visible in a multi-sheet workbook:
+ *
+ * @code
+ *     lxw_worksheet  *worksheet1  = workbook_add_worksheet(workbook, NULL);
+ *     lxw_chartsheet *chartsheet1 = workbook_add_chartsheet(workbook, NULL);
+ *     lxw_chartsheet *chartsheet2 = workbook_add_chartsheet(workbook, NULL);
+ *     lxw_chartsheet *chartsheet3 = workbook_add_chartsheet(workbook, NULL);
+ *
+ *     chartsheet_activate(chartsheet3);
+ * @endcode
+ *
+ * @image html chartsheet_activate.png
+ *
+ * More than one chartsheet can be selected via the `chartsheet_select()`
+ * function, see below, however only one chartsheet can be active.
+ *
+ * The default active chartsheet is the first chartsheet.
+ *
+ * See also `worksheet_activate()`.
+ *
+ */
+void chartsheet_activate(lxw_chartsheet *chartsheet);
+
+/**
+ * @brief Set a chartsheet tab as selected.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ *
+ * The `%chartsheet_select()` function is used to indicate that a chartsheet
+ * is selected in a multi-sheet workbook:
+ *
+ * @code
+ *     chartsheet_activate(chartsheet1);
+ *     chartsheet_select(chartsheet2);
+ *     chartsheet_select(chartsheet3);
+ *
+ * @endcode
+ *
+ * A selected chartsheet has its tab highlighted. Selecting chartsheets is a
+ * way of grouping them together so that, for example, several chartsheets
+ * could be printed in one go. A chartsheet that has been activated via the
+ * `chartsheet_activate()` function will also appear as selected.
+ *
+ * See also `worksheet_select()`.
+ *
+ */
+void chartsheet_select(lxw_chartsheet *chartsheet);
+
+/**
+ * @brief Hide the current chartsheet.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ *
+ * The `%chartsheet_hide()` function is used to hide a chartsheet:
+ *
+ * @code
+ *     chartsheet_hide(chartsheet2);
+ * @endcode
+ *
+ * You may wish to hide a chartsheet in order to avoid confusing a user with
+ * intermediate data or calculations.
+ *
+ * @image html hide_sheet.png
+ *
+ * A hidden chartsheet can not be activated or selected so this function is
+ * mutually exclusive with the `chartsheet_activate()` and
+ * `chartsheet_select()` functions. In addition, since the first chartsheet
+ * will default to being the active chartsheet, you cannot hide the first
+ * chartsheet without activating another sheet:
+ *
+ * @code
+ *     chartsheet_activate(chartsheet2);
+ *     chartsheet_hide(chartsheet1);
+ * @endcode
+ *
+ * See also `worksheet_hide()`.
+ *
+ */
+void chartsheet_hide(lxw_chartsheet *chartsheet);
+
+/**
+ * @brief Set current chartsheet as the first visible sheet tab.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ *
+ * The `chartsheet_activate()` function determines which chartsheet is
+ * initially selected.  However, if there are a large number of chartsheets the
+ * selected chartsheet may not appear on the screen. To avoid this you can
+ * select the leftmost visible chartsheet tab using
+ * `%chartsheet_set_first_sheet()`:
+ *
+ * @code
+ *     chartsheet_set_first_sheet(chartsheet19); // First visible chartsheet tab.
+ *     chartsheet_activate(chartsheet20);        // First visible chartsheet.
+ * @endcode
+ *
+ * This function is not required very often. The default value is the first
+ * chartsheet.
+ *
+ * See also `worksheet_set_first_sheet()`.
+ *
+ */
+void chartsheet_set_first_sheet(lxw_chartsheet *chartsheet);
+
+/**
+ * @brief Set the color of the chartsheet tab.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param color      The tab color.
+ *
+ * The `%chartsheet_set_tab_color()` function is used to change the color of
+ * the chartsheet tab:
+ *
+ * @code
+ *      chartsheet_set_tab_color(chartsheet1, LXW_COLOR_RED);
+ *      chartsheet_set_tab_color(chartsheet2, LXW_COLOR_GREEN);
+ *      chartsheet_set_tab_color(chartsheet3, 0xFF9900); // Orange.
+ * @endcode
+ *
+ * The color should be an RGB integer value, see @ref working_with_colors.
+ *
+ * See also `worksheet_set_tab_color()`.
+ */
+void chartsheet_set_tab_color(lxw_chartsheet *chartsheet, lxw_color_t color);
+
+/**
+ * @brief Protect elements of a chartsheet from modification.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param password   A chartsheet password.
+ * @param options    Chartsheet elements to protect.
+ *
+ * The `%chartsheet_protect()` function protects chartsheet elements from
+ * modification:
+ *
+ * @code
+ *     chartsheet_protect(chartsheet, "Some Password", options);
+ * @endcode
+ *
+ * The `password` and lxw_protection pointer are both optional:
+ *
+ * @code
+ *     chartsheet_protect(chartsheet2, NULL,       my_options);
+ *     chartsheet_protect(chartsheet3, "password", NULL);
+ *     chartsheet_protect(chartsheet4, "password", my_options);
+ * @endcode
+ *
+ * Passing a `NULL` password is the same as turning on protection without a
+ * password. Passing a `NULL` password and `NULL` options had no effect on
+ * chartsheets.
+ *
+ * You can specify which chartsheet elements you wish to protect by passing a
+ * lxw_protection pointer in the `options` argument. In Excel chartsheets only
+ * have two protection options:
+ *
+ *     no_content
+ *     no_objects
+ *
+ * All parameters are off by default. Individual elements can be protected as
+ * follows:
+ *
+ * @code
+ *     lxw_protection options = {
+ *         .no_content  = 1,
+ *         .no_objects  = 1,
+ *     };
+ *
+ *     chartsheet_protect(chartsheet, NULL, &options);
+ *
+ * @endcode
+ *
+ * See also worksheet_protect().
+ *
+ * **Note:** Sheet level passwords in Excel offer **very** weak
+ * protection. They don't encrypt your data and are very easy to
+ * deactivate. Full workbook encryption is not supported by `libxlsxwriter`
+ * since it requires a completely different file format.
+ */
+void chartsheet_protect(lxw_chartsheet *chartsheet, const char *password,
+                        lxw_protection *options);
+
+/**
+ * @brief Set the chartsheet zoom factor.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param scale      Chartsheet zoom factor.
+ *
+ * Set the chartsheet zoom factor in the range `10 <= zoom <= 400`:
+ *
+ * @code
+ *     chartsheet_set_zoom(chartsheet, 75);
+ * @endcode
+ *
+ * The default zoom factor is 100. It isn't possible to set the zoom to
+ * "Selection" because it is calculated by Excel at run-time.
+ *
+ * See also `worksheet_set_zoom()`.
+ */
+void chartsheet_set_zoom(lxw_chartsheet *chartsheet, uint16_t scale);
+
+/**
+ * @brief Set the page orientation as landscape.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ *
+ * This function is used to set the orientation of a chartsheet's printed page
+ * to landscape. The default chartsheet orientation is landscape, so this
+ * function isn't generally required:
+ *
+ * @code
+ *     chartsheet_set_landscape(chartsheet);
+ * @endcode
+ */
+void chartsheet_set_landscape(lxw_chartsheet *chartsheet);
+
+/**
+ * @brief Set the page orientation as portrait.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ *
+ * This function is used to set the orientation of a chartsheet's printed page
+ * to portrait:
+ *
+ * @code
+ *     chartsheet_set_portrait(chartsheet);
+ * @endcode
+ */
+void chartsheet_set_portrait(lxw_chartsheet *chartsheet);
+
+/**
+ * @brief Set the paper type for printing.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param paper_type The Excel paper format type.
+ *
+ * This function is used to set the paper format for the printed output of a
+ * chartsheet:
+ *
+ * @code
+ *     chartsheet_set_paper(chartsheet1, 1);  // US Letter
+ *     chartsheet_set_paper(chartsheet2, 9);  // A4
+ * @endcode
+ *
+ * If you do not specify a paper type the chartsheet will print using the
+ * printer's default paper style.
+ *
+ * See `worksheet_set_paper()` for a full list of available paper sizes.
+ */
+void chartsheet_set_paper(lxw_chartsheet *chartsheet, uint8_t paper_type);
+
+/**
+ * @brief Set the chartsheet margins for the printed page.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param left       Left margin in inches.   Excel default is 0.7.
+ * @param right      Right margin in inches.  Excel default is 0.7.
+ * @param top        Top margin in inches.    Excel default is 0.75.
+ * @param bottom     Bottom margin in inches. Excel default is 0.75.
+ *
+ * The `%chartsheet_set_margins()` function is used to set the margins of the
+ * chartsheet when it is printed. The units are in inches. Specifying `-1` for
+ * any parameter will give the default Excel value as shown above.
+ *
+ * @code
+ *    chartsheet_set_margins(chartsheet, 1.3, 1.2, -1, -1);
+ * @endcode
+ *
+ */
+void chartsheet_set_margins(lxw_chartsheet *chartsheet, double left,
+                            double right, double top, double bottom);
+
+/**
+ * @brief Set the printed page header caption.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param string     The header string.
+ *
+ * @return A #lxw_error code.
+ *
+ * Headers and footers are generated using a string which is a combination of
+ * plain text and control characters
+ *
+ * @code
+ *     chartsheet_set_header(chartsheet, "&LHello");
+ *
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    | Hello                                                         |
+ *     //    |                                                               |
+ *
+ *
+ *     chartsheet_set_header(chartsheet, "&CHello");
+ *
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                          Hello                                |
+ *     //    |                                                               |
+ *
+ *
+ *     chartsheet_set_header(chartsheet, "&RHello");
+ *
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                                                         Hello |
+ *     //    |                                                               |
+ *
+ *
+ * @endcode
+ *
+ * See `worksheet_set_header()` for a full explanation of the syntax of
+ * Excel's header formatting and control characters.
+ *
+ */
+lxw_error chartsheet_set_header(lxw_chartsheet *chartsheet,
+                                const char *string);
+
+/**
+ * @brief Set the printed page footer caption.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param string     The footer string.
+ *
+ * @return A #lxw_error code.
+ *
+ * The syntax of this function is the same as chartsheet_set_header().
+ *
+ */
+lxw_error chartsheet_set_footer(lxw_chartsheet *chartsheet,
+                                const char *string);
+
+/**
+ * @brief Set the printed page header caption with additional options.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param string     The header string.
+ * @param options    Header options.
+ *
+ * @return A #lxw_error code.
+ *
+ * The syntax of this function is the same as chartsheet_set_header() with an
+ * additional parameter to specify options for the header.
+ *
+ * Currently, the only available option is the header margin:
+ *
+ * @code
+ *
+ *    lxw_header_footer_options header_options = { 0.2 };
+ *
+ *    chartsheet_set_header_opt(chartsheet, "Some text", &header_options);
+ *
+ * @endcode
+ *
+ */
+lxw_error chartsheet_set_header_opt(lxw_chartsheet *chartsheet,
+                                    const char *string,
+                                    lxw_header_footer_options *options);
+
+/**
+ * @brief Set the printed page footer caption with additional options.
+ *
+ * @param chartsheet Pointer to a lxw_chartsheet instance to be updated.
+ * @param string     The footer string.
+ * @param options    Footer options.
+ *
+ * @return A #lxw_error code.
+ *
+ * The syntax of this function is the same as chartsheet_set_header_opt().
+ *
+ */
+lxw_error chartsheet_set_footer_opt(lxw_chartsheet *chartsheet,
+                                    const char *string,
+                                    lxw_header_footer_options *options);
+
+lxw_chartsheet *lxw_chartsheet_new(lxw_worksheet_init_data *init_data);
+void lxw_chartsheet_free(lxw_chartsheet *chartsheet);
+void lxw_chartsheet_assemble_xml_file(lxw_chartsheet *chartsheet);
+
+/* Declarations required for unit testing. */
+#ifdef TESTING
+
+STATIC void _chartsheet_xml_declaration(lxw_chartsheet *chartsheet);
+STATIC void _chartsheet_write_sheet_protection(lxw_chartsheet *chartsheet);
+#endif /* TESTING */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
+
+#endif /* __LXW_CHARTSHEET_H__ */