_CommonTableCapabilities

_CommonTableCapabilities

Overview

A number of macros that produce or modify tables share common capabilities as described below. A JavaScript enabled browser is required to enable most of these capabilities.

Capabilities

  • Column sorting - sort a column by clicking on column heading. Clicking again will reverse the order. 

  • Data specific sorting - see the columnTypes parameter

  • Column selection - hide columns

  • Auto sort of selected column

  • Auto numbering of rows - ability to automatically add a leading column with the data row count.

  • Auto totaling of numeric columns

  • Row highlighting on mouseover - the row is highlighted when mouse goes over any row element for non-heading rows

  • Row styles - ability to set CSS at the row level

  • Column styles - ability to set CSS at the column level

  • Column attributes - ability to set the display attributes (color, font) on a column basis

  • Table attributes - set table class, table style, and row styles - See Style Table Columns

Macros that include this support

Common parameters

The following parameters are 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

Description

Default

Macro Parameter

Number of header rows

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

1

heading

Number of footer rows

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

0

footing

Enable column sorting

Set to false to disable sorting.

TRUE

enableSorting

Enable row highlighting on mouse over

As the mouse moves over a table row, the row will be highlighted by default. Set to false to stop this behavior.

TRUE

enableHighlighting

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

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

FALSE

sortDescending

Sort tip text

Text displayed when mouse is over a sortable column. Normally, this value is Click to sort or equivalent translation.


sortTip

Display sort icon

Use true to include a sort icon in the first heading row for sortable columns. An icon will show for the last column sorted indicating the direction the column was sorted.

FALSE

sortIcon

Highlight color

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

lightgoldenrodyellow

highlightColor

Insert auto number column

Use true to show an additional column that show row number for each data row.

FALSE

autoNumber

Enable sorting on auto number column

Use true to enable the auto number column to be sortable. This will retain the original data row count even after row sorting.

FALSE

autoNumberSort

Auto total numeric columns

Use true to append a row to the end of the table that will contain totals of all numeric columns.

FALSE

autoTotal

Enable download and export as attachment

Enable user to download or export the current view of the table as a CSV file. Download is to the local file system. Export is to 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 will be 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.

FALSE

allowExport

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.

Type

Description

Sorting

Total Formatting

Data Formatting

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



I

Integer. This is a numeric field without a fractional component.

Numeric

(tick)


F

Numeric or float value and may contain numeric separators including a decimal point and a comma for thousands separator.

Numeric

(tick)


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.

Numeric

(tick)

FC

Numeric or float value and may contain numeric separators including a comma for decimal separator and a period for thousands separator.

Numeric

(tick)


C

Similar to F with more leniency on leading and trailing characters to allow currency and similar symbols to be present and ignored.

Numeric

(tick)


CC

Similar to FC with more leniency on leading and trailing characters to allow currency and similar symbols to be present and ignored.

Numeric

(tick)


M

Date format in many popular formats. See Advanced Date Sorting for more information. This is the preferred date sorting type.

Date


(tick)

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



E

Emoticons or other HTML elements.

Alphabetic on the inner HTML value



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



H

Indicates to hide the column.




Example Use

Column types: S,I,F"0,0",F"$0,0.00"


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

Header row styles

A comma separated list of styles. Each style is made up of one or more properties. The first is applied to all heading rows determined by the heading 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 resorting

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.

TRUE

retainRowStyleOrder

Column styles

Comma separated list of styles. Each style is made up of one or more CSS properties (semi-colon separated). The styles are applied to columns in sequence. 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

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


columnAttributes

Apply column attributes to header rows

Any column attributes provided will be applied to the all column rows including heading rows. Use false to have the column attributes apply only to data rows.

TRUE

enableHeadingAttributes

Table id

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

auto generated

id

Table class

Sets the class of the table. Normally, it will be confluenceTable. Use a blank (one or more spaces) value to not have any table class.

@default

class

Table style

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


style

Table width

In pixels or %. Recommend using style settings instead.


width

Border width

In pixels. Set class to blank also. Recommend using style settings instead.


border

Date sorting

See Advanced Date Sorting.

Examples

{table-plus:columnTypes=S,-,.|autoNumber=true|sortColumn=3 |columnAttributes=style="text-align:center;", ,style="background:yellow; font-size:14pt;"} || Name || Phone || TCP || | John | 555-1234 | 192.168.1.10 | | Mary Lou | 555-2134 | 192.168.1.12 | | Bob | 555-4527 | 192.168.1.9 | {table-plus}

which renders as:

Name

Phone

TCP

John

555-1234

192.168.1.10

Mary Lou

555-2134

192.168.1.12

Bob

555-4527

192.168.1.9