List topics

Lists the selected topics and their status in a ordered list.

There are a list of elements can be configured in the dashlet:

Height in canvas rows¶

Defines the height in number of rows given to the dashlet.

The height value will be between 1 and 4 where 4 will occupy 100% of the page.

Width in canvas columns¶

Sets the width that the item will occupy in the dashboard.

The maximum allowed value is 12 (100% width).

Autorefresh¶

Allows to make the dashlet more dinamic adding an automatic refresh (in minutes).

List of fields to view in grid¶

Allows to select specific fields to view. By default the dashlet will show the following columns: ID, title, status, creator and creation date.

Columns can be customized by separating field definitions with ; (semicolons).

Each field definition is a comma-separated list of tokens:

field_name,label,type,width,[options...]

The first four tokens are positional:

Token	Position	Description	Required
`field_name`	1	The internal field ID (fieldlet ID or built-in field name such as `title`, `name_status`, `created_by`, `created_on`, `modified_by`, `modified_on`, `assignee`, `projects`)	Yes
`label`	2	Column header label displayed in the dashlet	No
`type`	3	Field type: `text`, `number`, `number(N)` (N = decimal places), `checkbox`, `ci`	No (defaults to `text`)
`width`	4	Column width in pixels. When set, the header text wraps to fit	No (auto-sized)

After position 4, the remaining tokens are auto-detected by value and can be in any order:

Token	Values	Description
`total`	`sum`, `min`, `max`, `count`, `avg`	Aggregation for the totals row
`number_format`	`currency`	Use locale-aware decimal formatting
`symbol`	Any other value (e.g. `$`, `€`, `%`)	Unit symbol appended after the value
`align`	`left`, `center`, `right`	Text alignment (defaults to `center`, `left` for title)

Example with alignment and totals:

my_field,My Label,number,,sum,right

Examples¶

A simple three-column layout:

title,Title;created_by,Created By;name_status,Status

A numeric column with totals, currency formatting and alignment:

title,Title;created_by,Created By;incoming,My Incoming,number(2),,sum,currency,$,right

This produces:

    Title  | Created by  | My Incoming
    ------------------------------------
    Title1 | 2016-02-02  |    23.25 $
    ------------------------------------
                          |    Total: $

Types¶

Text¶

Default type. Displays the raw field value as text.

Number¶

Displays a numeric value. Append decimal precision in parentheses: number(2) shows 2 decimal places.

With the total token (position 5), a totals row can show:

sum - Sum of all values in the column.
max - Maximum value.
min - Minimum value.
count - Number of rows.
avg - Average of all values.

The number_format token (position 6) can be set to currency to format numbers using the user's locale preferences (US format with . for decimals or standard format with ,).

The symbol token (position 7) appends a unit symbol after the value (e.g. $, €, %).

Example: title,Title;created_by,Created By;incoming,My incoming,number(2),,sum,currency,$

    Title  | Created by  | My incoming
    ------------------------------------
    Title1 | 2016-02-02  | 23,25 $

Checkbox¶

Displays a graphical check/uncheck icon instead of 1 or 0 for boolean fieldlets.

Example: title,Title;created_by,Created By;my_check,Approved,checkbox

CI¶

Resolves resource MIDs to their display names. Useful for user fields like owner or assignee that store internal IDs.

Example: title,Title;created_by,Created By;owner,Owner,ci

Without ci type:

    Title  | Created by  | Owner
    --------------------------------
    Title1 | 2016-02-02  | 1108

With ci type:

    Title  | Created by  |  Owner
    --------------------------------
    Title1 | 2016-02-02  | admin-1

Maximum number of topics to list¶

Set the maximun number of topics to show in the table. By default is set to 100.

If you want to show all topics, just set it to 0.

Sort by¶

Set an order by a determinated field (specified by the ID fieldlet). By default sorts by topic ID.

Sort order¶

Indicate ASC or DESC order.

Show totals row?¶

Include a last row showing total if we have a number type in the table.

Select topics in categories¶

Select one o more categories to show in the grid.

Select topics in statuses¶

Select one o more status to configure the table.

Exclude selected statuses?¶

Exclude selected classes in the previous combo and show the rest that no selected.

User assigned to topics¶

Allow to filter the topics by user assigned or by any user.

Advanced condition JSON/MongoDB¶

Allows to use a JSON format o MongoDB query to add a condition.

  {"labels":[],"categories":["*id*"],"statuses":[],"priorities":[],"start":0,"limit":25}

Where id is the unique key of the category which can be consulted through the REPL.