array.map
Perform an operation on every element of an array object, replacing elements in-place
Description
Each element of an incoming array will be output sequentially. After processing the element, it should be passed back into the right inlet of the array.map object, replacing the element in the array. When iteration is complete, the substituted array will be output.
Arguments
None.
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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
Reprocess previously received array and trigger output.
int
In the left inlet, convert an incoming integer to an array, then process as described for the array message. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
float
In the left inlet, convert an incoming floating-point number to an array, then process as described for the array message. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
list
In the left inlet, convert an incoming list to an array, then process as described for the array message. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
anything
In the left inlet, convert an incoming list to an array, then process as described for the array message. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
array
In the left inlet, an incoming array will trigger the output of each element sequentially, as a series of individual messages. The element index will be output from the rightmost outlet, and the element value from the middle outlet.
Each of these messages can be processed (synchronously or asynchronously) and then returned to the array.map object's right inlet. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
cancel
Cancels the currently active mapping operation. The array.map object will now be ready to start mapping a new array.
dictionary
In the left inlet, wrap an incoming dictionary object in an array, then process as described for the array message. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
string
In the left inlet, wrap a string object in an array, then process as described for the array message. In the right inlet, the incoming value will replace the last-output array element and either trigger the next phase of the iteration, or, if the iteration is complete, cause output of the mapped array.
See Also
| Name | Description |
|---|---|
| array | Create or duplicate an array object |
| array.filter | Output elements of an array matching a condition |
| array.reduce | Combine array elements based on a custom function |