_CommonTableParameters81

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.

Tabs

Macro Editor Label

Default

Description

Macro Parameter

Table settings

Formatting

Table id

auto generated

Table ID can be referenced for use in macros (like the chart macro) or Javascript.

id

Table class

@default

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

Style attributes can be set. For example: font-style:italic; background:lightblue;.

style

Table width

In pixels or %. Recommendation is to use style settings instead.

width

Border width

In pixels. Set class to blank also. Recommendation is to use style settings instead.

border

Advanced settings

Enable download and export as attachment

Off

Enables user 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. This is a new option starting with Advanced Tables 7.2, SQL 8.3, and Excel 6.3.

allowExport

Display data filter

Off

Turn this toggle On 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.

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.

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

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

Column types determine how column data is sorted and displayed. By default, column data is treated as a text string sorted alphabetically. Some macros, like the SQL and CSV macros, may automatically generate more precise types. When the default behavior is less than optimal for your situation, the columnTypes parameter can be set specifically. This describes the behavior of the various types. In addition, numeric types are right aligned and can result in a total row entry.

Navigate to Column settings > Formatting > Column type in the respective macro to select from the list of available column types.

Type	Description	Sorting
String (S)	Text string. This is a series of one or more alphanumeric characters, possibly including a letter, number, space, punctuation mark or other special characters.	Alphabetic
Integer (I)	Integer. This is a numeric field without a fractional component.	Numeric
Numeric or float values (F)	Numeric or float value and may contain numeric separators including a decimal point and a comma for thousands separator.	Numeric
Numeric with data formatting (FF)	Numeric or float value and may contain numeric separators including a decimal point and a comma for thousands separator. Forced formatting of data columns. If this column type is specified and the column contains any text or non-numeric value, this value is rendered as a zero (0).	Numeric
Float with comma as decimal point (FC)	Numeric or float value and may contain numeric separators including a comma for decimal separator and a period for thousands separator.	Numeric
Currency (C)	Similar to F with more leniency on leading and trailing characters to allow currency and similar symbols to be present and ignored.	Numeric
Currency with comma as decimal points (CC)	Similar to FC with more leniency on leading and trailing characters to allow currency and similar symbols to be present and ignored.	Numeric
Date (M)	Date format in many popular formats. See Advanced Date Sorting for more information. This is the preferred date sorting type.	Date
Date in the browser date format (D)	Date in the browser date format. See Advanced Date Sorting for more information. The D type is available for compatibility with older releases - the M type is recommended.	Date
Complex HTML elements like emotions or similar (E)	Emoticons or other HTML elements.	Alphabetic on the inner HTML value
Exclude this column from user selectable sorting (X)	Indicates to exclude this column from user selectable sorting.	Disabled
.	Separated numbers, like phone numbers or TCP addresses. Valid values are multiple integer numbers separated by '.'.	Numeric on each separated value
:	Separated numbers, like phone numbers or TCP addresses. Valid values are multiple integer numbers separated by ':'.	Numeric on each separated value
-	Separated numbers, like phone numbers or TCP addresses. Valid values are multiple integer numbers separated by '-'.	Numeric on each separated value
/	Separated numbers, like phone numbers or TCP addresses. Valid values are multiple integer numbers separated by '/'.	Numeric on each separated value
Hide the column (H)	Indicates to hide the column.

Total formatting - option to format the total row in a user defined way. See Format the Auto Total Row for Numeric Columns.
Numeric data formatting - option to format the data rows in a user defined way for numeric columns. See Formatting Options for Numeric Columns.
Date data formatting - option to format the data rows in a user defined way for date columns. See Formatting Options for Date Columns.

columnTypes

Total type

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.

Type	Result
sum	Column entries are totaled. The column type must be numeric.
avg	Column entries are totaled and then divided by the number of data rows. The column type must be numeric.
avgIgnoreZero	Column entries are totaled and then divided by the number of data rows that are non-zero and non-blank. The column type must be numeric. Requires Table Library 3.5 and above.
max	The largest data value among the column entries is returned. The Column type must be numeric.
min	The smallest data value among the column entries is returned. The Column type must be numeric.
<other text>	Any other text including a blank field will be copied to the corresponding total row field. No calculations are done.

The Max and Min Total type is available only for Advanced Tables for Confluence: Server and Data Center.

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 that will be applied to the column cells.

columnAttributes

Numbering & Totaling

Insert auto number column

Off

Turn this parameter On to show an additional column that show row number for each data row.

autoNumber

Enable sorting on auto number column

Off

Turn this toggle On to enable the auto number column to be sortable. This will retain the original data row count even after row sorting.

autoNumberSort

Apply column attributes to header rows

On

Any column attributes provided will be applied to the all column rows including heading rows. Turn this parameter Off to have the column attributes apply only to data rows.

enableHeadingAttributes

Apply Column styles to data cells

Off

Turn this toggle On 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

Turn this parameter On to append a row to the end of the table that will contain totals of all numeric columns.

autoTotal

Sorting

Enable column sorting

On

Turn this parameter Off to disable sorting.

enableSorting

Automatically sort this column

The table can be auto sorted before it is displayed by any valid column name or number provided by this parameter. No auto sorting will be 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

Automatically sort in descending order

Off

If sortColumn is used, this determines the order of the sort that is automatically done before display.

sortDescending

Display sort icon

Off

Turn this parameter On to include a sort icon in the first heading row for sortable columns. An icon appears for the last column sorted indicating the direction the column was sorted.

sortIcon

Sort tip text

Text displayed when mouse is over a sortable column. Normally, this value is Click to sort or 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: background:lightyellow, background:lightblue

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 rows

1

Number of rows to be considered as heading rows. Heading rows do not participate in column sorting.

heading

Header row styles

A comma separated list of styles (similar to Row styles) that is applied on the header row.

rowStyles

Number of footer rows

0

Number of rows to be considered as footing rows. Footing rows do not participate in column sorting.

footing

Advanced settings

Retain row style order after re-sorting

On

When selected, the row styles correspond to the order the rows are displayed on the screen. When not selected, the original style given to a row is retained not matter where the row lands after sorting.

retainRowStyleOrder

Apply Row styles to data rows

Off

Turn this toggle On 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

As the mouse moves over a table row, the row is highlighted by default. Turn this parameter Off to stop this behavior.

enableHighlighting

Highlight color

lightgoldenrodyellow

Color of row when mouse is over a row element. See Web Colors for instructions on how to specify this.

highlightColor