Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Mybanner

This version of the app's documentation is outdated. Please find the information you're looking for here:


Table Filter is one of the three macros bundled in Table Filter and Charts for Confluence add-on. This macro allows you to filter your table data with the following filter types:

  • Drop-down filter fetches all the unique values from the selected table column and allows you to select one or multiple values to filter your table by.
  • Free text filter allows you to enter custom text query to filter data in the selected column. This filter support regular expression so you can enter custom text queries for flexible data filtration.
  • Global filter works the same way as free text filter but it filters data throughout the whole table.
  • Number range filter allows you to specify the number ranges for filtering data values within the pre-defined range.
  • Date filter allows you to select the time period for showing data values.
  • Visual filter allows you to select the appropriate icons, emoticons, images or state of check boxes for filtration.

See the next pages for the details on how to work with the macro:

Children Display

Inserting Table Filter macro on the page

There exist three ways to insert the Table Filter macro on the page.

Macro InsertionInstructionsSupported Data

Inserting the macro in the page view mode

Info

You can disable the inline macro insertion on a global or individual basis.


  1. Open a page with a table.
  2. Hove over the table.
  3. Click the Filter table data Image Added icon on the panel that appears to the right side of the table.

Image Added

Info

This option is available in Confluence Server only.


  1. Manually created and copied tables
  2. Macros outputting table data
Inserting the macro through the action icon on the editor pane
  1. Switch Confluence page to the edit mode.
  2. Position the mouse pointer within the table.
    Image Added
  3. On the editor pane, click the Filter table data Image Addedicon.
Info

This option is available in Confluence Server only.


  1.  Manually created and copied tables
Manual entry of the {Table Filter} query on the page
  1. Switch Confluence page to the edit mode.
  2. Position the mouse pointer in the appropriate place on the page.
  3. Start entering {Table Filter}.
  4. From the prompted list of macro choices, select Table Filter.
    Image Added
  1. Manually created and copied tables
  2. Macros outputting table data
Selection of the Table Filter macro in the Select Macro form
  1. Switch Confluence page to the edit mode.
  2. Position the mouse pointer in the appropriate place on the page.
  3. On the editor pane, click Insert.
  4. In the Select Macro form, locate the Table Filter macro and insert it on the page.
    Image Added
  5. Place the table within the macro.
  1. Manually created and copied tables
  2. Macros outputting table data




Removing Table Filter macro for Tables

  1. Switch Confluence page to the edit mode.
  2. Select the Table Filter macro with the table or macro outputting the table.
  3. Click Unwrap.
Info

This option is available in Confluence Server only.


Image Added



Copying a table into Table Filter macro

  1. Switch Confluence page to the edit mode.
  2. Position the mouse pointer into any cell of the table you want to copy.
  3. Click the Copy TableImage Added icon on the editor pane.
  4. Paste the table into the Table Filter macro on the same or on a new page.
Info

This option is available in Confluence Server only.


Image Added

Tip

We recently released versions 2.0 and 2.1.0 with a bunch of new features! Check the release notes to learn more.

 

This page explains

Table of Contents
maxLevel2

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.

Image Removed

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.

Image Removed 

Info

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).

Image Removed

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.

Image Removed

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 words Developer or Doe in any columns.

Image Removed

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.

Talk
idtalk-266

How to set default values for filters

To set your filter to some default value, enter it in the field Default Values for Filters. If you want to specify a default value for other than the first field (e.g. City in the screen shot below), put comma-separated blank spaces for each field preceding it. 

Image Removed

 To set more than two or more default value for a drop-down filter, connect these values with && as shown below.

Image Removed

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.

Image Removed

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

Image Removed

How to change the look of filters

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

Image Removed

Selecting the checkbox Hide Filters by Default 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.

Image Removed

 

Enter a filter field width in pixels in Filter Cells Width. To set individual parameters for each of the filters, separate the width values with commas.

Image Removed

How to disable filters

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

Image Removed

...