A newer version of Max is available. Click here to access the latest version of the Max documentation

array.sort Reference

Sort the elements of an array object according to a test.

array.sort

Description

Each pair of entries is output, the user compares them and then passes a 1 (left is > right) or a 0 (left is <= right) to determine a final sorted order.

Discussion

Similar to array.map and array.reduce, as the object iterates over the elements of the array, send a value to the rightmost inlet to finish processing each pair, until the final result is determined.

Arguments

None.

Attributes

simple [int]

Simple sorting mode Possible values:

0 = 'Off'
1 = 'Ascending'
2 = 'Descending'

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

Reprocess previously received arrays and trigger output.

int

Arguments

value [int]
Convert an incoming integer to an array, then process as described for the array message.

  (inlet1)

As you compare each two elements of the array, send the comparison result to the rightmost inlet.

float

Arguments

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

list

Arguments

list-value [list]
Convert an incoming list to an array, then process as described for the array message.

anything

Arguments

list-value [list]
Convert an incoming list to an array, then process as described for the array message.

array

Pairs of array elements will be output from the second and third outlets. Compare them and send the result to the rightmost inlet, sending a 1 if the left is greater than the right, or a 0 if the right is greater than or equal to the left. Finally, the object will output the sorted result. The input array is not modified, but a sorted copy is output.

cancel

TEXT_HERE

dictionary

Arguments

dictionary-value [list]
Wrap an incoming dictionary object in an array, then process as described for the array message.

string

Arguments

string-value [list]
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.filter Output elements of an array matching a condition.
array.map Perform an operation on every element of an array object, replacing elements in-place.
array.reverse Reverse the order of elements in an array object.
coll Store and edit a collection of data
zl.sort Arrange a list in alphanumeric order