Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page properties
hiddentrue



Status
Tech review

Status
colourYellow
titletodoReady for review

Style guide

Status
colourYellow
titletodoReady for review

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


Short description

Filters a numberissue, or a text list by a given boolean expression.

Output

Status
subtletrue
titlelist

Available since

Status
subtletrue
colourBlue
title2.1.32




Panel

Supported list types

Table of Contents
exclude(Supported list types).*
stylecircle
typeflat
separatorpipe


Number list

UI Text Box
sizemedium
typeinfo

This function filters a number list by a given boolean expression where ^ is used for referencing the current list value.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByPredicate(numberList, booleanExpression) #Output: Number list


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
filterByPredicate([1, 2, 3, 4], ^ > 2)


This example returns a number list with values greater than 2 : [3, 4]


Code Block
languagebash
linenumberstrue
filterByPredicate([1, 2, 3, 4], modulus(^, 2) = 0) 


This example returns a number list with even values : [2, 4]



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
numberList

Status
subtletrue
titlenumber list

Any given number list.
booleanExpression

Status
subtletrue
titleboolean

A boolean expression that returns true or false.

^ is used for referencing the current list value.



UI Expand
titleOutput

This function returns a

Status
subtletrue
titlenumber list



Text list

UI Text Box
sizemedium
typeinfo

Variant for text lists. The current list value is referenced by ^%.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByPredicate(textList, booleanExpression) #Output: Text list


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
filterByPredicate(["book", "rose", "sword"], length(^%) > 4)


This example returns a text list with words that have more than 4 characters: ["sword"]


Code Block
languagebash
linenumberstrue
filterByPredicate(["book", "rose", "sword"], ^% in %{00000} OR ^% in %{00001})


This example returns a text list with those words that also appear in the issue's Summary or Description.



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
textList

Status
subtletrue
titletext list

Any given text list.
booleanExpression

Status
subtletrue
titleboolean

A boolean expression that returns true or false.

^% is used for referencing the current list value.



UI Expand
titleOutput

This function returns a

Status
subtletrue
titletext list



Issue list

UI Text Box
sizemedium
typeinfo

Variant for issue lists.

This function returns an issue list  with issues in l whose cardinality (i.e., the number of times it appears in list l) satisfies the comparison cardinality operator n.

Available comparison operators: =, !=, <, <=, > and >=.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByPredicate(issueList, booleanExpression) #Output: Issue list


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
filterByCardinalityfilterByPredicate(linkedIssues(), >, 1^%{issue.summary} ~ %{issue.summary}) 


This example returns an issue list with all issues linked to current issue with 2 or more issue links. linked issues that have the same summary like the current issue.

To achieve this, the following functions are used:


Code Block
languagebash
linenumberstrue
filterByPredicate(issuesUnderEpic(), ^%{issue.assignee} = null) 


This example returns an issue list with all unassigned issues under the current epic.

To achieve this, the following functions are used:



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
issueList

Status
subtletrue
titledata type

Parameter descriptionAny given issue list. Usually this value is retrieved from a function (e.g. linkedIssues() or subtasks()).
booleanExpression

Status
subtletrue
titledata type

A boolean expression that returns true or false.

^ in front of field codes is used to reference the list's current issue

Parameter description

.



UI Expand
titleOutput

This function returns an

Status
subtletrue
titleissue list