Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

Provides information about collections of items.

Details

Name:

Collection Supplier

Prefix:

collection(optional)

Supported Content:

Collections, such as lists, sets and arrays.

Provided By:

Reporting for Confluence

Supported Keys

The following are the list List of keys which this that the supplier will return a value for.

Key

Content Types

Return Type

Description

size

Collection

Number

The number of items in the collection.

is empty

Collection

Boolean

Test if the collection is empty.

first

Collection

Anything

(Since 2.0.0) Returns

Returns the first item in the collection, if anything is present.

Status
colourBlue
titleFrom 2.0.0+

Info

If there is only one item in the collection then you must use this parameter

.

last

Collection

Anything

(Since 2.0.0) Returns

Returns the last item in the collection, if anything is present.

Status
colourBlue
titleFrom 2.0.0+

[X]

Collection

Anything

(Since 2.0.0) Returns

Returns the X'th item in the collection, where X is a number between 1 and 'size'.

Status
colourBlue
titleFrom 2.0.0+

join with [X]

Collection

Text

Since 3.0.0) Joins

Joins the 'to string' value of all the collection contents into a Text

, with

Status
colourBlue
titleFrom 3.0.0+

  • the '[X]' value is put between each item. e.g.: 'text:join with ", "'.

random

Collection

Anything

(Since 3.1.0) Returns

Returns a random item from the provided list of elements.

Status

shuffle

colour

Collection

Blue

Collection

title

(Since

From 3.1.0

) Returns

+

shuffle

Collection

Collection

Returns the collection of items but scrambles the order of the elements.

reverse

Status
colour

Collection

Blue

Collection

title

(Since

From 3.

2

1.0

) Returns

+

reverse

Collection

Collection

Returns the collection of items in reverse order.

Status
colourBlue
titleFrom 3.2.0+

collect [X]

Collection

Collection

(Since 4.0.0)

Returns a collection of the same length made up of sub-values of each item in this collection with the specified keyword of 'X'.

Status
colourBlue
titleFrom 4.0.0+