(OUTDATED) Table Filter and Charts for Confluence

Space shortcuts

Page tree

Versions Compared

Old Version 71

changes.mady.by.user Vadim Rutkevich

Saved on

compared with

New Version Current

changes.mady.by.user Natalie Paramonova

Saved on

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

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 snippets 'Morocco' or '1500 mln' in any columns.

Image Removed

How to filter date range?

Info

This functionality is not available for Confluence Cloud version.

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.

Image Removed

Info

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?

How to filter number range?

Info

This functionality is not available for Confluence Cloud version.

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.

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.

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.

Image Removed 

 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.

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 the Hide Labels box.

Image Removed

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.

Image Removed

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

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

How to add automatic row numbering

Info

This functionality is not available for Confluence Cloud version.

While editing the Table filter macro, select the Automatic row numbering option. You can choose between dynamic and static row numbering.

Image Removed

How to hide table columns

Info

This functionality is not available for Confluence Cloud version.

  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.

Image Removed

How to limit the table height

Info

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.

Image Removed

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

Image Removed

Changing order of filters when editing the macro

Info

This functionality is not available for Confluence Cloud version.

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

Image Removed

How to export the table with filtered data to PDF/Word

Info

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.

...