The parameters listed on this page are part of our common table capabilities that are available to many macros that produce or modify tables.
| Macro Editor Label | Default | Description | Macro Parameter |
|---|---|---|---|
| Number of heading rows | 1 | Enter the number of rows to be considered as heading rows. Heading rows do not participate in column sorting. | heading |
| Enable column sorting | true | Deselect this option to disable sorting of columns. | 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 data row. | 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 ( ) are displayed to the right of the table. File is downloaded to the user's local file system, or is exported as an attachment to the current page. Note that only those users that have the permission to add attachments to the page are allowed to export tables. | allowExport |
| 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 a 1-based count of columns (excluding auto number column). | 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 | Column types determine how column data is sorted and displayed. By default, column data is treated as a text string sorted alphabetically. When the default behavior is less than optimal for your situation, the Column types parameter can be set specifically. This page describes the behavior of the various types. In addition, numeric types are right aligned and can result in a total row entry. The following column types are not supported in the current release:
These column types are expected to be featured in the upcoming release. | columnTypes | |
| Column calculations | When an auto total parameter is selected, this parameter can be used to customize the calculation or text that is shown on the total row. By default, all numeric fields, as specified by column types, are totaled. By specifying a comma separated list of calculation requests, the behavior can be modified using special values for the corresponding column. The Max and Min Total type is available only for Advanced Tables for Confluence: Server and Data Center. | columnCalculations | |
| Table 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. 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: | rowStyles | |
| Retain row style order after sorting | 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 |
| 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. 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 | |
| Column attributes | Enter a comma separated list of values used to modify cell 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. | 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 style | Specify style attributes for the table. Example: | style | |
| Table border width | Enter width for the table border in pixels. It is recommended to use Table style instead. | border |
