array.group Reference

Output an array when it reaches a certain size

array.group

Description

Outputs an array after the number of elements specified by the group size are received. Incoming arrays larger than the group size are split into multiple output arrays.

Arguments

initial-size [int]

Optional

Specifies a number of elements from incoming arrays to be grouped and output.

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

Immediately outputs current array (even if it hasn't reached the maximum size).

int

Convert an incoming integer to an array, then process as described for the array message.

  (inlet1)

Arguments

array-size [int]
Specifies a number of elements from incoming arrays to be grouped and output.

float

Convert an incoming floating-point number to an array, then process as described for the array message.

list

Convert an incoming list to an array, then process as described for the array message.

anything

Convert an incoming list to an array, then process as described for the array message.

array

Append elements to the output array. When the output array reaches the size specified as an argument (or as an int in the right inlet), it will be sent from the outlet. Upon output, the output array is reset to length 0.

clear

Resets the length of the output array to 0

dictionary

Wrap an incoming dictionary object in an array, then process as described for the array message.

string

Wrap a string object in an array, then process as described for the array message.

See Also

Name Description
array Create or duplicate an array object.
array.iter Iterate every element of an array object.
array.stream Make an array of a certain size
array.tuplewise Make an array of a certain size (counting iterations)
zl.group Store and output a list
zl.iter Successively output lists of specific size