Table Plus macro - 8.x
On this page
Overview
The Table Plus macro adds advanced functions and formatting to Confluence tables, by:
Dynamically totalling numeric data.
Dynamically numbering each table row.
Defining the default sort order for the table.
Highlighting a row when the user hovers the pointer over it.
Using CSS to style the entire table or individual columns and rows.
This macro supports certain common table capabilities. This adds column sorting and other attributes to one or more tables found in the body of the macro. The tables can be produced by wiki markup or other means. Clicking a column heading sorts the column and clicking again, reverses the order. Note that the Excel, CSV, or SQL macros already have most of these capabilities.
Basic use
This macro can be deployed using one of the following methods:
Selected from the macro browser | Advanced Tables - Table Plus |
|---|---|
Markup shortcut | {table-plus} |
In the body of the macro, insert a Confluence table as you normally would and edit the row and columns as needed. On rendering or preview, the Table Plus macro processes the table to add the advanced capabilities according to the parameters specified on the macro.
Screenshot
Table Plus option in menu
The Table Plus macro can be added to the Insert More Content menu for quick and easy access.
Parameters
Table settings
Tab | Macro editor label | Default | Description | Macro parameter |
|---|---|---|---|---|
Advanced settings | Apply settings to nested tables | On | All embedded tables are affected by the table properties specified. Set this to false to only apply the table properties to the outer table. | multiple |
Common parameters
The parameters listed on this page are part of our common table capabilities that are available in many macros that produce or modify tables.
Click a column heading to toggle the sorting of that column.
Tabs | Macro Editor Label | Default | Description | Macro Parameter |
|---|---|---|---|---|
Table settings | ||||
Formatting | Table id | auto generated | Enter an ID for the table. Can be referenced for use in macros like the chart macro or Javascript. | id |
Table class | @default | Enter a class to set the styles for the table. Sets the class of the table. Normally, it is confluenceTable. Use a blank value (one or more spaces) to not have any table class. | class | |
Table style |
| Enter CSS styles to be used for the table. For example: | style | |
Table width |
| Enter width of the table in pixels or %. Recommended to use Table style instead. | width | |
Border width |
| Enter the border width for the table in pixels. Set class to blank also. Recommended to use Table style instead. | border | |
Advanced settings | Enable download and export as attachment | Off | Enable this option to allow users to download or export the current view of the table as a CSV file. Downloads to the local file system. Exports as an attachment to the current page and is only available to users that have permission to add attachments to the page. When enabled, download and export icons () are available to the right of the table. Only those users that have the permission to add attachments to the page are allowed to export tables. If enabled, select a character from the drop-down to be used as a delimiter for the data to be downloaded or exported. The options provided are:
Valid only if Enable download and export as attachment is enabled. Available since 8.2.0 version. For Macro Security users:From app version 8.3.4 onwards, if this parameter is added to Macro Security Configuration in the macroname.allowExport format, the download/export icons are displayed only to the permitted users, groups, spaces, and/or pages based on the specified restrictions. For more information about Macro Security settings, refer to this article. | allowExport |
Display data filter | Off | Enable this option to display a drop-down list with unique column values under each column heading. By default, the None option is selected. Select filter values in multiple columns to see a more specific row. Select None to display all rows for that column. As filters are applied on other columns, the display of information differs. Select None for all columns to show all rows for all columns. Available since 8.3.0.
There is a known issue with the Display data filter parameter. When you select the drop-down for the first time, the column gets sorted though the list is not visible, and from the next click onwards, the list drops down displaying the unique values available in that column. This does not affect the working of the filters in any way. | displayDataFilter | |
Column settings | ||||
Formatting | Column styles |
| Click Start Formatting to format your table columns. Each of the column styles is made up of one or more CSS properties (semi-colon separated). The styles are applied to the respective columns as provided in the editor window. A style can be reused for subsequent columns by using a numeric reference of the column. (For example, you want to reuse 3rd column style in 6th - use 3 as style value in column 6) Column styles are applied to the table column and participate with other CSS properties to determine the look of an element. In particular, some properties may be overridden by table, row, or element styles or classes. Example: When the Insert auto number column parameter is On, say you want to repeat a column style, use numeric reference of this column +1 in the intended column. For example, to reuse 3rd column style in 6th when Insert auto number column is On - use 4 as style value in column 6. | columnStyles |
Column type |
| columnTypes | ||
Total type |
| columnCalculations | ||
Column attributes |
| Click and select Show column attributes to view the respective columns attributes field in the editor. Specifies a comma separated list of values used to modify cell attributes for the respective column. Each value is a double semi-colon list of attributeName=value pairs to be applied to the column cells. | columnAttributes | |
Numbering & Totaling | Insert auto number column | Off | Enable this option to show an additional column that show row number for each data row. | autoNumber |
Auto number column styles |
| Enter the CSS styles to be applied on the auto number column. Valid only if Insert auto number column is enabled. | autoNumberColStyles | |
Enable sorting on auto number column | Off | Enable this option to enable the auto number column to be sortable. This retains the original data row count even after row sorting. | autoNumberSort | |
Apply column attributes to header rows | On | Disable this option to have the column attributes apply only to data rows. By default, any column attributes provided are applied to the all column rows including heading rows. | enableHeadingAttributes | |
Apply Column styles to data cells | Off | Enable this option to make the styles in the Column styles field (Formatting tab) persist for the specified columns. Available since 8.1.0. |
| |
Auto total numeric columns | Off | Enable this option to append a row to the end of the table that contains the totals of all numeric columns. | autoTotal | |
Sorting
| Enable column sorting | On | Disable this option to disable sorting. | enableSorting |
Automatically sort this column |
| Enter a valid column name or number to automatically sort the table before it is displayed. No automatic sorting is done if this value is not provided or is invalid. A column number is indexed beginning at "1" and excludes any auto-numbered columns. | sortColumn | |
Automatically sort in descending order | Off | Enable this option to sort in the descending order, to be done automatically, before display. This works only if Auto sort column is specified. | sortDescending | |
Display sort icon | Off | Enable this option to include a sort icon in the first heading row for sortable columns. An icon is displayed for the last column sorted indicating the direction in which the column was sorted. | sortIcon | |
Sort tip text |
| Enter the text to be displayed when the mouse is over a sortable column. Example: Click to sort or an equivalent translation. | sortTip | |
Row formatting | ||||
Data rows | Row styles |
| Click Start Styling to format your table rows. Each of the row styles is made up of one or more properties. Each style is applied to the respective row. Row styles are applied to the table row and participate with other CSS properties to determine the look of an element. In particular, some properties may be overridden by table or element styles or classes. Example:
| row index |
Header & Footer rows | Number of header rows | 1 | Enter the number of rows to be considered as heading rows. Heading rows are not considered in the sorting of columns. | heading |
Header row styles |
| Enter a comma-separated list of CSS styles (similar to Row styles) that is applied on the header row. | rowStyles | |
Hide header rows | Off | Enable this option to hide the table header rows as specified in Number of header rows. By default, all header rows are shown.
| hideHeader | |
Number of footer rows | 0 | Enter the number of rows to be considered as footing rows. Footing rows are not considered in the sorting of columns. | footing | |
Auto total row styles |
| Enter the CSS styles to be applied on the auto total row. Valid only if Column settings > Numbering and totaling > Auto total numeric columns is enabled. | autoTotalRowStyle | |
Advanced settings | Retain row style order after re-sorting | On | Disable this option to retain the original style given to a row no matter where the row is displayed after sorting. By default, the row styles correspond to the order the rows are displayed on the screen. | retainRowStyleOrder |
Apply Row styles to data rows | Off | Enable this option to make the styles in the Row styles field (Data rows tab) persist for the specified columns. Available since 8.1.0. |
| |
Enable row highlighting on mouse over | On | Disable this option to stop row highlighting as the mouse moves over a table row. By default, the row is highlighted as the mouse moves. | enableHighlighting | |
Highlight color | lightgoldenrodyellow | Enter a color to highlight when the mouse is over a row element. See Web Colors for instructions on how to specify this. | highlightColor | |
Examples
- Allow export of table view - 8.x
- Auto-number rows and auto-total numeric columns - 8.x
- Column selection - 8.x
- Dynamic column selection - 8.x
- Control the width of table columns - 8.x
- Column width with fixed layout - 8.x
- Column width with fixed layout and break-word - 8.x
- Format the Auto Total row for numeric columns - 8.x
- Improve the Jira Issues macro with the Table Plus macro - 8.x
- Style table columns - 8.x
- Style table rows - 8.x
- Background color row style incompatibility in Confluence 5.0 - 8.x
Other macros
The list of all other macros available within this app is as follows:
Additional references
Need support? Create a request with our support team.
