This page explains the following topics:

How to filter one table with a drop-down filter

To filter a table, enter the Edit mode, find Table Filter in the Insert - Other Macros menu and insert it to the page. Then either copy and paste an already existing table or create a new table inside the macro.

To specify filtering parameters in the macro browser, click inside the macro and choose Edit in the appeared menu.

To add a drop-down list of values, enter table headers in the Column(s) field or choose them from the list.

Hover over the funnel sign in the filter pane to see the number of filtered and total rows.

 

To make your work with long tables more comfortable, you can specify the number of top rows to show in the Show first N rows field.

How to filter more than one table

To filter two or more tables, place them inside the Table Filter macro. You can set up individual filters for tables (the Country filter in the example below) or filters that affect all tables (the City filter).

How to add a textbox filter

To add a textbox filter, enter the table header(s) in the User Filtered Columns field or choose them from the list.

How to use the global filter

Select the Global Filter option to enable filtering by all columns. In the example below, a regular expression is used to filter all rows containing the snippets 'Morocco' or '1500 mln' in any columns.

How to filter date range

The add-on allows you to filter rows with dates within the specific range.

  1. Open the macro and locate the Date Filter Columns box.
  2. Click it and select the columns containing the dates.
  3. In the Date Format box, specify the appropriate date format used in the column.
  4. Once you have saved the page, locate the box for a column with dates and using the date picker define the appropriate date range.

The date format can be specified and alternated depending on your table date.

Use the following formats for specifying date:

  • yy - year
  • mm - month
  • dd - day

For the details on date formats, see What date formats are supported?

Starting from version 3.1.0 the add-on supports filtration of cells containing both date and time. Filtration occurs only by date, time value is skipped.

How to filter number range

The add-on allows you to filter rows with numbers within the specific range.

  1. Open the macro and locate the Number Filter Columns box.
  2. Click it and select the columns containing the numbers.
  3. Once you have saved the page, locate the box for a column with number and enter the appropriate number range.

How to manage filters in the view page mode

Starting from version 3.1.0 Table Filter add-on supports management of filters in the view page mode. In such a way, you can manage filters of all types, including the box for hiding specific columns of the table.

You can perform the following actions on filters:

You may encounter the four situations, as follows:

You have inserted the table into the Table filter macro, added filters and saved the page.

In this case, you will see the screen similar to the one displayed. You can add new filters by clicking the Add filter icon.

You have inserted the table into the Table filter macro and saved the page without any configuration.

In this case, you will see the screen similar to the one displayed. You can add the required filters by clicking the Add filter icon.

You have inserted the table into the Table filter macro and enabled automatic row number or/and default sorting.

In this case, no filtration pane will be displayed. You will have to switch the page to the edit mode and then configure settings of the Table Filter macro while editing it.

You have not inserted the table into the Table filter macro.

In this case, you will see the corresponding notification about the missing table in the macro body. You will have to swith the page to the edit mode and insert the table into the macro body. Then you can add the filters either when editing the page or viewing it.

Adding filters in the page view mode

  1. On the filtration pane, locate the Add filter icon and click it.
  2. Select the appropriate filter type and the column for data filtration.
  3. To save the modifications in the macro body, click the Save settings icon.

If adding the number or date filters, additional configuration of the data format may be required.

Deleting filters in the page view mode

  1. On the filtration page, locate the filter you want to remove.
  2. Click and drag the filter to the bottom of the page.
  3. Release the left mouse button. The filter will be removed.
  4. To save the modifications in the macro body, click the Save settings icon.

Saving default values for filters in the page view mode

  1. Locate the filter you want to specify default values for.
  2. Select or enter the appropriate default values for one or multiple filters.
  3. To save the modifications in the macro body, click the Save settings icon.

Saving filter width in the page view mode

  1. Locate the filter box which width you want to change.
  2. Position the mouse pointer at the right border of the filter box, until the cursor changes.
  3. Click and hold the left mouse button and drag the filter box border to the left or or to the right.
  4. Release the left mouse button when width of the filter box is appropriate.
  5. To save the modifications in the macro body, click the Save settings icon.

You can change the box width for the following filter types:

  • Dropdown filter
  • Free text filter
  • Global filter
  • Hide columns selector

Changing order of filters on the filtration pane

  1. Locate the filter box which position on the filtration pane you want to change.
  2. Click and drag the filter box to the appropriate position on the filtration pane.
  3. Release the left mouse button when complete.
  4. To save the modifications in the macro body, click the Save settings icon.

You can only change order of filter boxes of the same type on the filtration pane. For example, you cannot position the global filter between the two dropdown filters.

How to use regular expressions in textbox filters

You can use JavaScript-style regular expressions in textbox filters. 

Examples

Regular ExpressionMatched Values
[Dd]oeDoe, doe
colo(u)?rcolor, colour
Developer|ScientistDeveloper, Scientist

The full list of regular expressions is available here.

How to set default values for filters

Open the macro and .point to the Filters' Default Values button and then click it. Select the appropriate value for the current dropdown filter.

 

 You can set multiple default values for each drop-down filter. You can delete the added default values by clicking the Close icon available on each value.

How to apply default sorting order to the columns

Starting from version 3.1.0 Table Filter add-on allows you to apply default sorting order to values in multiple columns.

  1. Open the macro and locate the Default Sorting box.
  2. Click it and select the columns with the appropriate sorting order in them.
  3. Once you have saved the macro and the page, the defined sorting order is automatically applied to the selected columns.


How to use Table Filter with the JIRA Issues and Task Report add-ons

To filter tables produced by the JIRA Issues and Taks Report add-ons, put these macros inside the Table Filter macro.

Set filters and use Table Filter as with an normal table.

How to change the look of filters

You can remove filter names from the Confluence page by selecting the Hide Labels box.

Selecting the Hide Filters by Default box will add the Show/Hide filter switch to the page, so that every user could control the visibility of the filter pane in the View mode.

Click the Width of Filters button and enter the appropriate width (in pixels) for the filter fields. You can set width for each field.

How to disable filters

To temporarily disable filters, click the icon. All entered filter values will be restored when you enable filtering.

How to add automatic row numbering

While editing the Table filter macro, select the Automatic row numbering option. You can choose among the following options:

How to hide table columns

  1. While editing the Table filter macro, select the Hide columns option.
  2. Click the Filters' Default Values button.
  3. Locate the Hide columns box and select the columns you want to hide.
  4. Click Save.

How to limit the table height

This functionality is not available for Confluence Cloud version.

While editing the Table filter macro, select the Limit table height option. The add-on will automatically limit height of your table to fit it to your screen.

Once you have saved the page, the table will automatically fit the screen area.

Changing order of filters when editing the macro

You can change order of filters by dragging the column label to the appropriate place in all filter boxes.

How to export the table with filtered data and default sorting order to PDF/Word

This functionality is not available for Confluence Cloud version.

  1. Apply the required filters to your data table.
  2. From the Tools menu, select either Export to PDF or Export to Word.
  3. The filtered table will be exported to PDF or Word file.