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

Add functions to access axis and error bar pointers.

Browse Source 
Add functions to return pointers to chart axis and error bar
pointers as syntactic sugar for wrapper languages that can't
access the pointers directly.

Issue #142
This commit is contained in:
John McNamara 2018-02-11 13:24:46 +00:00
parent 269f3dce62
commit d863c8e1fd
5 changed files with 146 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.indent.pro vendored
View File

@ -53,7 +53,9 @@
-T lxw_chart_axis_label_position
-T lxw_chart_axis_tick_mark
-T lxw_chart_axis_tick_position
-T lxw_chart_axis_type
-T lxw_chart_blank
-T lxw_chart_error_bar_axis
-T lxw_chart_error_bar_cap
-T lxw_chart_error_bar_direction
-T lxw_chart_error_bar_type

95
include/xlsxwriter/chart.h
View File

@ -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,
@ -815,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.
*/
@ -2016,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.
@ -2079,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:
@ -2161,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.
*

37
src/chart.c
View File

@ -5576,6 +5576,24 @@ chart_series_set_trendline_line(lxw_chart_series *series,
series->trendline_line = _chart_convert_line_args(line);
}
/*
* Set the X or Y error bars from a chart series.
*/
lxw_series_error_bars *
chart_series_get_error_bars(lxw_chart_series *series,
lxw_chart_error_bar_axis axis_type)
{
if (!series)
return NULL;
if (axis_type == LXW_CHART_ERROR_BAR_AXIS_X)
return series->x_error_bars;
else if (axis_type == LXW_CHART_ERROR_BAR_AXIS_Y)
return series->y_error_bars;
else
return NULL;
}
/*
* Set the error bars and type for a chart series.
*/
@ -5640,6 +5658,23 @@ chart_series_set_error_bars_line(lxw_series_error_bars *error_bars,
error_bars->line = _chart_convert_line_args(line);
}
/*
* Get an axis pointer from a chart.
*/
lxw_chart_axis *
chart_axis_get(lxw_chart *self, lxw_chart_axis_type axis_type)
{
if (!self)
return NULL;
if (axis_type == LXW_CHART_AXIS_TYPE_X)
return self->x_axis;
else if (axis_type == LXW_CHART_AXIS_TYPE_Y)
return self->y_axis;
else
return NULL;
}
/*
* Set an axis caption.
*/
@ -5656,7 +5691,7 @@ chart_axis_set_name(lxw_chart_axis *axis, const char *name)
}
/*
* Set an axis caption, with a range instead or a formula..
* Set an axis caption, with a range instead or a formula.
*/
void
chart_axis_set_name_range(lxw_chart_axis *axis, const char *sheetname,

12
test/functional/src/test_chart_errorbars04.c
View File

@ -42,12 +42,18 @@ int main() {
"=Sheet1!$C$1:$C$5"
);
chart_series_set_error_bars(series1->y_error_bars,
LXW_CHART_ERROR_BAR_TYPE_STD_ERROR, 0);
lxw_series_error_bars *x_error_bars;
lxw_series_error_bars *y_error_bars;
chart_series_set_error_bars(series1->x_error_bars,
x_error_bars = chart_series_get_error_bars(series1, LXW_CHART_ERROR_BAR_AXIS_X);
y_error_bars = chart_series_get_error_bars(series1, LXW_CHART_ERROR_BAR_AXIS_Y);
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);
worksheet_insert_chart(worksheet, CELL("E9"), chart);

7
test/functional/src/test_chart_gridlines01.c
View File

@ -36,8 +36,11 @@ int main() {
chart_add_series(chart, NULL, "=Sheet1!$B$1:$B$5");
chart_add_series(chart, NULL, "=Sheet1!$C$1:$C$5");
chart_axis_major_gridlines_set_visible(chart->x_axis, LXW_TRUE);
chart_axis_major_gridlines_set_visible(chart->y_axis, LXW_FALSE);
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);
chart_axis_major_gridlines_set_visible(x_axis, LXW_TRUE);
chart_axis_major_gridlines_set_visible(y_axis, LXW_FALSE);
worksheet_insert_chart(worksheet, CELL("E9"), chart);