_CommonTableCapabilitiesParametersXLCld

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:

Numeric with data formatting (FF)
Float with comma as decimal point (FC)
Currency with comma as decimal points (CC)

These column types are expected to be featured in the upcoming release.

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
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
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

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.

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

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

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: background:lightyellow, background:lightblue,1,2,1,2

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: font-style:italic; background:lightblue;.

style

Table border width

Enter width for the table border in pixels. It is recommended to use Table style instead.

border