The parameters listed here are a part of our common table capabilities that are available to many macros that produce or modify tables.
| Info |
|---|
Click a column heading to toggle the sorting of that column. |
| Macro Editor Label | Default | Description | Macro Parameter |
|---|---|---|---|
| Heading rows | 1 | Enter the number of rows |
that act as heading rows. Heading rows |
are not included when columns are sorted.
| heading | ||
| Footing rows | 0 | Enter the number of rows |
that act as footing rows. Footing |
rows are not included when columns are sorted.
| footing | ||
| Columns to show | Enter a comma-separated list of |
column names or numbers in any order. By default, all columns are displayed in |
their existing order. |
Note that columns are indexed beginning at "1" and excludes any auto-numbered columns.
| columns | ||
| Enable column sorting | true | Deselect this option to disable sorting of columns. By default, all columns are sorted automatically based on their column types. | enableSorting |
| Enable row highlighting on mouse over | true | 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 |
| Enable heading attributes | true | Disable this option to apply the column attributes only to data rows. By default, any column attributes provided are applied to the all column rows including heading rows. | enableHeadingAttributes |
| Auto number on each row | false | Enable this option to show an additional column that displays the row number for each |
| row. By default, the table rows are not numbered. | autoNumber |
| Auto total row | false |
Enable this |
option to append a row at the end of the table that contain the totals of all numeric columns.
| autoTotal | ||
| Allow download and export | false | Enable this option to allow download or export of the current table view |
as a CSV file |
. When enabled, download and export icons ( |
. Note that only those users that have the permission to add attachments to the page |
) are displayed to the right of the table.are allowed to export tables. | allowExport | ||||
| Export file delimiter | , (Comma) | Enter a single character to be used as a delimiter for the table to be downloaded or exported. By default, a comma (,) is used as the delimiter. Valid only if Allow download and export is enabled. Available since 2.9.0.
| |||
| Display data filter | false | Enable this option to see filter panel above the table to filter the data. 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 |
| displayDataFilter | |||||
| Sort auto number column | false | Select this option to enable the auto number column to be sortable. This retains the original data row count even after row sorting.
| autoNumberSort | ||
| Sort descending | false | 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 | ||
| Show sort icon | false | 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 | ||
| Auto sort 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 | |||||
| Sort tip on mouse over | Enter the text to be displayed when the mouse is over a sortable column. Example: Click to sort or an equivalent translation. | sortTip | ||||
| Column types |
|
|
| columnTypes | ||||||||
| Column calculations |
| columnCalculations | |||||||
| Row styles | Enter a comma-separated list of styles to be applied to the specified rows. Each style is made up of one or more properties. The first style is applied to all heading rows determined by the Number of heading rows parameter. The remaining styles are applied to the remaining rows in order with repetition as necessary. A style can be reused for subsequent rows by referring to it using a 1-based numeric reference. A column number is indexed beginning at "1" and excludes any auto-numbered columns. 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 can be overridden by table or element styles or classes. Example: | rowStyles | |||||||
| Retain row style order after resorting | true | Enable this option to make the row styles correspond to the order in which the rows are displayed on the screen. If not selected, the original style given to a row is retained regardless of where the row lands after sorting. | retainRowStyleOrder | ||||||
| Apply row style to individual cell | false | Enable this option to apply the styles mentioned in Row styles to each cell of the specified row(s). This option is used to override the default Confluence styles and make the user-defined styles persist for the specified table rows. Available since version 2.8. | |||||||
| Column styles | Enter a comma-separated list of styles to be applied to the columns in the specified sequence. Each style is made up of one or more CSS properties (semi-colon separated). If a column is skipped, supply a comma before adding the next columns style. A style can be reused for subsequent columns by referring to it using a 1-based numeric reference. A column number is indexed beginning at "1" and excludes any auto-numbered columns. 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: | columnStyles | |||||||
| Apply Column styles to data column cells | Enable this option to apply the styles mentioned in Row styles to each cell of the specified row(s). This option is used to override the default Confluence styles and make the user-defined styles persist for the specified table rows. Available since version 2.8. | ||||||||
| Column attributes | Enter a comma-separated list of values used to modify cell HTML attributes for all cells in a column. The position in the comma-separated list corresponds to the column that the values apply to. Each value is a double semi-colon list of attributeName=value pairs to be applied to the column cells. See HTML attributes for more information. | columnAttributes | |||||||
| 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 | ||||||
| Table id | Auto generated | Displays the table ID that can be referenced for use in other macros (like the Chart macro) or Javascript. | id | ||||||
| Table class | @default | Specify the table class (CSS) to apply to render tables.
| class | ||||||
| Table style | Specify style attributes for the table. Example: | style | |||||||
| Table width | Enter width for the table border in pixels or as a percentage (%). It is recommended to use Table style instead.
| width | |||||||
| Table border width | Enter width for the table border in pixels. Set Table class to blank if the width specified here is to be applied to the table. It is recommended to use Table style instead.
| border |