Versions Compared

Key

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

The parameters listed on this page are a part of our common table capabilities that are available in many macros that produce or modify tables.

...

Table plus


TabsMacro Editor LabelDefaultDescriptionMacro Parameter

Table settings

Formatting

Table idauto generatedEnter an ID for the table. Can be referenced for use in macros like the chart macro or Javascript.id
Table class@defaultEnter 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: font-style:italic; background:lightblue;.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 settingsEnable download and export as attachmentOff

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.

Note

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:

  • Comma: Default delimiter valuedelimiter value.
  • Tab
  • Semicolon
  • Space
  • Other: Select this option to specify a character that is not in the drop-down, to be used as a delimiter. Enter a single character to be used as a delimiter in the adjoining text box. The downloaded or exported file contents are separated with this character.

Valid only if Enable download and export as attachment is enabled. Available since 8.2.0 version

Info
titleFor 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 filterOffEnable this option to display a filter panel above the table. Panel contains a text box to enter the required search criteria and buttons: Filter to proceed with the search, and, Clear to clear the box to start a new search. Can use regular expressions. To know more about regular expressions, refer to the this article. Available since 8.1.0to 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. 

Note
  • Filters are applicable only for text based searches, and are not applicable on data in nested macros or nested tables currently.
  • This version of applying filters replaces the previous feature available since version 8.1.0. In the earlier version, a filter panel was displayed above the table and the search text box accepted regular expressions. From version 8.3.0, only column filters are available for tables.


Info

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: background:lightyellow

Note

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

Include Page
_ColumnTypes80
_ColumnTypes80

columnTypes
Total type

Include Page
_ColumnCalculations
_ColumnCalculations

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 columnOff

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 columnOffEnable 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 rowsOnDisable 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 cellsOffEnable 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 columnsOffEnable this option to append a row to the end of the table that contains the totals of all numeric columns.autoTotal
Sorting



Enable column sortingOnDisable 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 orderOff

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
OffEnable 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 rowsRow 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: background:lightyellow, background:lightblue

Note
  • These styles are applied to the data rows starting from the first row below the header and not to the header itself. 
  • A row style can be reused for subsequent rows by using a numeric reference of this row + 1. For example, to reuse 3rd row style in 6th - use 4 as style value in row 6.


row index
Header & Footer rows

Number of header rows1Enter 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 rowsOff

Enable this option to hide the table header rows as specified in Number of header rows. By default, all header rows are shown. 

Note
  • This option is not applicable for the Attachment Table macro.
  • If Number of header rows is 0, the header row is displayed as a regular data row even if this option is enabled.
  • Any styles given for header rows are ignored if this option is enabled.


hideHeader
Number of footer rows0Enter 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-sortingOnDisable 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 rowsOffEnable 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 overOn

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 colorlightgoldenrodyellowEnter a color to highlight when the mouse is over a row element. See Web Colors for instructions on how to specify this.highlightColor


...