From 6f8046f4a74feb3c79226e702622e8fccd5f7dc8 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Thu, 13 Jun 2019 10:15:15 -0700 Subject: [PATCH] pivot-table: Better document how to hide empty rows and columns. Suggested by John Darrington. --- src/output/pivot-table.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/output/pivot-table.h b/src/output/pivot-table.h index 6104cb1313..c7198a2add 100644 --- a/src/output/pivot-table.h +++ b/src/output/pivot-table.h @@ -60,13 +60,20 @@ union value; Creating a pivot table usually consists of the following steps: 1. Create the table with pivot_table_create(), passing in the title. + It's commonly useful to set up a few options at this point: + + - If empty rows or columns should not be displayed, set ->omit_empty to + true. + + - Set the format to use for "count" values with + pivot_table_set_weight_var() or pivot_table_set_weight_format(). 2. Create each dimension with pivot_dimension_create() and populate it with categories and, possibly, with groups that contain the categories. This call also assigns the dimension to an axis. In simple cases, only a call to pivot_dimension_create() is needed. - Other functions such as pivot__create_group() can be used for + Other functions such as pivot_category_create_group() can be used for hierarchies of categories. Sometimes it's easier to create categories in tandem with inserting data, @@ -370,7 +377,7 @@ struct pivot_table bool rotate_outer_row_labels; bool row_labels_in_corner; bool show_grid_lines; - bool omit_empty; + bool omit_empty; /* Omit empty rows and columns? */ size_t *current_layer; /* axis[PIVOT_AXIS_LAYER]->n_dimensions elements. */ char *table_look; enum settings_value_show show_values; -- 2.30.2