This function takes the name of an array and drops all fields of this array.
Parameter | Type | Required | Default Value | Description |
---|---|---|---|---|
array [a] | string | required | Name of the array to drop values for. Must follow valid Array Syntax for array of scalars. For example, for events with fields incidents[0], incidents[1], ... this would be incidents[] . | |
[a] The parameter name |
array:drop()
requires that the input array has
continuous, sequential indexes with no gaps (empty indexes) and that the
array starts at index [0], for example, incidents[0], incidents[1],
incidents[2]. If there are gaps, for example, incidents[0], incidents[1],
incidents[2], incidents[10] only the fields from index 0 up to the first
empty index will be dropped.
If no array with the given name exists, the function does nothing.
Without this function, each element of an array would need to be dropped
individually using drop()
or
array:filter()
as shown below:
array:filter(array="a[]", function={false}, var="")
With the function, specify the name of the array field to drop:
array:drop("a[]")
Validation:
The array parameter is validated to ensure the field is an array value.
array:drop()
Examples
Click
next to an example below to get the full details.Drop Fields From Input Array
Drop fields in an array using the array:drop()
function