Versions Compared

Key

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


Page properties
hiddentrue



Status
Tech review

Status
titletodo

Style guide

Status
titletodo

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



Page properties
hiddentrue


Short description

Returns Filters numberissue, or a text list in l that validate predicate 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 returns filters number list in l that validates predicate.Argument predicate is a boolean expression, where  by a given boolean expression where ^ is used for referencing numeric values in argument lthe current value.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByPredicate(number list lnumberList, boolean expression predicatebooleanExpression) #Output: Number list


UI Expand
titleExamples


Parser expressionDescription


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


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


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


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



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
xxxnumberList

Status
subtletrue
titledata typenumber list

Any given number listParameter description.
xxxbooleanExpression

Status
subtletrue
titledata typeboolean

A boolean expression that returns true or false.

^ is used for referencing the current value

Parameter description

.



UI Expand
titleOutput

This function returns a

Status
subtletrue
titlenumber list



Text list

UI Text Box
sizemedium
typeinfo

This function returns a text list with texts in l that validates predicate.

Argument predicate is a boolean expression, where ^% is used for referencing string values in argument lVariant for text lists. The current value is referenced by ^%.


Code Block
languagebash
titleSyntax
linenumberstrue
filterByPredicate(string list ltextList, boolean expression predicatebooleanExpression) #Output: Text list


UI Expand
titleExamples


Parser expressionDescription


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


This example returns the following text listtext 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 strings in first argument words that also appear in the issue's Summary or Description.



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
xxxtextList

Status
subtletrue
titledata typetext list

Any given text listParameter description.
xxxbooleanExpression

Status
subtletrue
titledata typeboolean

A boolean expression that returns true or false.

^% is used for referencing the current value

Parameter description

.



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
filterByCardinality(issue list l, comparison operator operator, number nfilterByPredicate(issueList, booleanExpression) #Output: Issue list


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
filterByCardinality(linkedIssues(), >, 1) 


This example returns an issue list with all issues linked to current issue with 2 or more issue links.



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
xxxissueList

Status
subtletrue
titledata type

Parameter description.xxx
Status
subtletrue
titledata type
Parameter description.xxxbooleanExpression

Status
subtletrue
titledata type

Parameter description.



UI Expand
titleOutput

This function returns an

Status
subtletrue
titleissue list