Versions Compared

Key

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

Button handy
blanktrue
color#0052CC
nameSend Feedback
linkhttps://docs.google.com/forms/d/e/1FAIpQLScmToBe3vynAlb5fdKwCGxYqnTbDc66sIBgeecG2BuFDuHc7g/viewform?entry.2002826954=arrayAddElement+-+15480932
widthauto

Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

arrayAddElement(arrayName, elem)

Package

array

Alias

addElement(arrayName, elem)

Pkg Usage

addElement(arrayName, elem)

Description

Excerpt
hiddentrue
If elem is an element of the array type, returns a new array that includes the specified element at the end.

If elem is an element of the array type, returns a new array that includes the specified element at the end.

...

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

Parameter name

Type

Required

Description

arrayName

Array

Yes

Array the new element is added to.

elem

Any

Yes

Element to be added. Must be the same type as the array type.

Return Type

Array

Examples

Example 1

Code Block
languagejs
watchers2 = addElement(watchers, currentUser());

The result returned by the routine function is assigned to a new array watchers2, so the initial array watchers will not be modified.

Example 2

Code Block
languagejs
watchers = addElement(watchers, currentUser());

The result returned by the routine function is assigned to the same array watchers, so the initial array watchers will be modified.

Note

If elem is not the same type as declared in the array definition, the

...

function returns error.

Info
Starting with version 2.5 is easier for you to just use the '+' operator to add elements to an array. array = array + element it is a simple and more meaningful way to express it. array += element is even better.

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "array_routine" and space = currentSpace ( )
labelsarray_routines