c/libxlsxwriter
1
0
Fork 0
mirror of https://github.com/jmcnamara/libxlsxwriter synced 2025-03-28 21:13:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for chart up-down bars.

Browse Source
This commit is contained in:
John McNamara 2017-01-22 03:03:03 +00:00
parent 6e82474759
commit 37eea6ed87
6 changed files with 108 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/chart_data_tools4.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 74 KiB

BIN
docs/images/chart_up_down_bars.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB

12
docs/src/examples.dox
View File

@ -714,14 +714,22 @@ A demo of an various Excel chart data tools that are available via a
libxlsxwriter chart. These include Drop Lines and High-Low Lines.
Chart with high-low lines.
Chart 1: chart with high-low lines.
@image html chart_data_tools5.png
Chart with drop lines.
Chart 2: chart with drop lines.
@image html chart_data_tools6.png
Chart 3: chart with Up-down bars.
@image html chart_data_tools4.png
Chart 4: chart with formatted Up-down bars.
@image html chart_up_down_bars.png

12
docs/src/examples.txt
View File

@ -363,14 +363,22 @@ A demo of an various Excel chart data tools that are available via a
libxlsxwriter chart. These include Drop Lines and High-Low Lines.
Chart with high-low lines.
Chart 1: chart with high-low lines.
@image html chart_data_tools5.png
Chart with drop lines.
Chart 2: chart with drop lines.
@image html chart_data_tools6.png
Chart 3: chart with Up-down bars.
@image html chart_data_tools4.png
Chart 4: chart with formatted Up-down bars.
@image html chart_up_down_bars.png
##############################################################
@example chart_fonts.c

42
examples/chart_data_tools.c
View File

@ -89,5 +89,47 @@ int main() {
worksheet_insert_chart(worksheet, CELL("E18"), chart);
/*
* Chart 3. Example with Up-Down bars.
*/
chart = workbook_add_chart(workbook, LXW_CHART_LINE);
/* Add a chart title. */
chart_title_set_name(chart, "Chart with Up-Down bars");
/* Add the first series to the chart. */
chart_add_series(chart, "=Sheet1!$A$2:$A$7", "=Sheet1!$B$2:$B$7");
chart_add_series(chart, "=Sheet1!$A$2:$A$7", "=Sheet1!$C$2:$C$7");
/* Add Up-Down bars to the chart. */
chart_set_up_down_bars(chart);
/* Insert the chart into the worksheet. */
worksheet_insert_chart(worksheet, CELL("E34"), chart);
/*
* Chart 4. Example with Up-Down bars with formatting.
*/
chart = workbook_add_chart(workbook, LXW_CHART_LINE);
/* Add a chart title. */
chart_title_set_name(chart, "Chart with Up-Down bars");
/* Add the first series to the chart. */
chart_add_series(chart, "=Sheet1!$A$2:$A$7", "=Sheet1!$B$2:$B$7");
chart_add_series(chart, "=Sheet1!$A$2:$A$7", "=Sheet1!$C$2:$C$7");
/* Add Up-Down bars to the chart, with formatting. */
lxw_chart_line line = {.color = LXW_COLOR_BLACK};
lxw_chart_fill up_fill = {.color = 0x00B050};
lxw_chart_fill down_fill = {.color = LXW_COLOR_RED};
chart_set_up_down_bars_format(chart, &line, &up_fill, &line, &down_fill);
/* Insert the chart into the worksheet. */
worksheet_insert_chart(worksheet, CELL("E50"), chart);
return workbook_close(workbook);
}

48
include/xlsxwriter/chart.h
View File

@ -2467,8 +2467,52 @@ void chart_set_table_grid(lxw_chart *chart, uint8_t horizontal,
void chart_set_table_font(lxw_chart *chart, lxw_chart_font *font);
/**
* @brief Turn on up-down bars for the chart.
*
* @param chart Pointer to a lxw_chart instance to be configured.
*
* The `%chart_set_up_down_bars()` function adds Up-Down bars to Line charts
* to indicate the difference between the first and last data series:
*
* @code
* chart_set_up_down_bars(chart);
* @endcode
*
* @image html chart_data_tools4.png
*
* Up-Down bars are only available in Line charts. By default Up-Down bars are
* black and white like in the above example. To format the border or fill
* of the bars see the `chart_set_up_down_bars_format()` function below.
*/
void chart_set_up_down_bars(lxw_chart *chart);
/**
* @brief Turn on up-down bars for the chart, with formatting.
*
* @param chart Pointer to a lxw_chart instance to be configured.
* @param up_bar_line A #lxw_chart_line struct for the up-bar border.
* @param up_bar_fill A #lxw_chart_fill struct for the up-bar fill.
* @param down_bar_line A #lxw_chart_line struct for the down-bar border.
* @param down_bar_fill A #lxw_chart_fill struct for the down-bar fill.
*
* The `%chart_set_up_down_bars_format()` function adds Up-Down bars to Line
* charts to indicate the difference between the first and last data series.
* It also allows the up and down bars to be formatted:
*
* @code
* lxw_chart_line line = {.color = LXW_COLOR_BLACK};
* lxw_chart_fill up_fill = {.color = 0x00B050};
* lxw_chart_fill down_fill = {.color = LXW_COLOR_RED};
*
* chart_set_up_down_bars_format(chart, &line, &up_fill, &line, &down_fill);
* @endcode
*
* @image html chart_up_down_bars.png
*
* Up-Down bars are only available in Line charts.
* For more format information see @ref chart_lines and @ref chart_fills.
*/
void chart_set_up_down_bars_format(lxw_chart *chart,
lxw_chart_line *up_bar_line,
lxw_chart_fill *up_bar_fill,
@ -2500,7 +2544,7 @@ void chart_set_up_down_bars_format(lxw_chart *chart,
* @endcode
*
* Drop Lines are only available in Line and Area charts.
*
* For more format information see @ref chart_lines.
*/
void chart_set_drop_lines(lxw_chart *chart, lxw_chart_line *line);
@ -2529,7 +2573,7 @@ void chart_set_drop_lines(lxw_chart *chart, lxw_chart_line *line);
* @endcode
*
* High-Low Lines are only available in Line charts.
*
* For more format information see @ref chart_lines.
*/
void chart_set_high_low_lines(lxw_chart *chart, lxw_chart_line *line);