_CommonTableParametersSQL10

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

Tabs

Macro Editor Label

Default

Description

Macro Parameter

Table settings

Formatting

Table id

auto generated

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

id

Table class

@default

Enter the class of styles to be applied for the table. By default, value is confluenceTable. Use a blank (one or more spaces) value to not have any table class.

class

Table style

Enter style attributes for the table. For example: font-style:italic; background:lightblue;.

style

Table width

Enter width for the table in pixels or %. Recommend use of Table style instead.

width

Border width

Enter width for the table border in pixels. Set class to blank. Recommend use of Table style instead.

border

Advanced settings

Enable download and export as attachment

Off

Enable this option to allow download or export of the current view of the table as a CSV file. Downloads to the local file system. Exports table 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 displayed to the right of the table. Available since SQL 8.3.0.

allowExport

File delimiter to use when download and export is enabled. Default value is comma.

, (Comma)

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 value used as the delimiter.
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 10.2.0.

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 10.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 10.2.0. In the earlier version, a filter panel was displayed above the table and the search text box accepted regular expressions. From version 10.3.0, only column filters are available for tables.

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 semi-colon separated CSS properties. 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, 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 can be overridden by table, row, element styles, or classes.

Example: background:lightyellow.

When the Insert auto number column parameter is On, if 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.

Specify a comma separated list of values to modify cell attributes for the respective column. Each value is a double semi-colon list of attributeName=value pairs that are applied to the column cells.

columnAttributes

Numbering & Totaling

Numbering

Insert auto number column

Off

Toggle this option On to show an additional column that shows row number for each data row.

autoNumber

Auto number column styles

Enter styles to be applied on the auto number column using Cascading Style Sheets (CSS) when auto number is enabled. Example: background:lightyellow

Enable sorting on auto number column

Off

Toggle this option On 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

Toggle this option Off to have the column attributes apply only to data rows. Any column attributes provided is applied to the all column rows including heading rows.

enableHeadingAttributes

Apply Column styles to column cells

Off

Toggle this option On to override default Confluence styles and make the styles specified in the Column styles field (Formatting tab) persist for the respective columns. Available since 10.2.0.

Totaling

Auto total numeric columns

Off

Toggle this option On to append a row to the end of the table that contains the totals of all numeric columns.

autoTotal

Sorting

Enable column sorting

On

Toggle this option Off to disable sorting.

enableSorting

Automatically sort by this column

Enter the column name or column number that the table must be auto sorted on before it is displayed. No auto sorting is performed 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

Toggle this option On to sort the column(s), specified in Automatically sort by this column, in descending order automatically before the table is displayed.

sortDescending

Display sort icon

Off

Toggle this option On to include a sort icon in the first heading row for sortable columns. An icon is shown for the last column sorted indicating the direction the column was sorted.

sortIcon

Sort tip text

Enter the text to be displayed when mouse is over a sortable column. For example, this value can be Click to sort or an equivalent translation.

sortTip

Row formatting

Data rows

Row styles

Click Start Styling to format your table rows.

Each row style is made up of one or more properties that is applied to the respective row. Row styles are applied to the specified table row and participate with other CSS properties to determine the look of an element. In particular, some properties can be overridden by table, 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

Enter the number of rows to be considered as heading rows. Heading rows do not participate in column sorting.

heading

Header row styles

Enter a comma separated list of styles, similar to Row styles (Data rows tab), to be applied on the header row.

rowStyles

Advanced settings

Retain row style order after re-sorting

On

Toggle this option Off to retain the original style given to a row regardless where the row lands after sorting. By default, the row styles correspond to the order the rows are displayed on the screen. When disabled, the original style given to a row is retained not matter where the row lands after sorting.

retainRowStyleOrder

Apply Row styles to row cells

Off

Toggle this option On to override default Confluence styles and make the styles specified in the Row styles field (Data rows tab) persist for the respective rows. Available since 10.2.0.

Enable row highlighting on mouse over

On

Toggle this option Off to stop highlighting the table row as the mouse moves over it.

enableHighlighting

Highlight color

lightgoldenrodyellow

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

highlightColor