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

toggle Reference

Switch between off and on (0/1)



When clicked, toggle outputs a 0 when turned off and a 1 when turned on. When giving input, a non-zero number will turn it on, a 0 will turn it off, and a bang will alternate the state of the toggle. All numbers are converted to integer and passed through unchanged.


Used as an onscreen controller, or to display the on/off status of numbers passing through




bgcolor [4 floats]

Sets the background color for the object in RGBA format.

checkedcolor [4 floats]

Sets the checked color for the object in RGBA format.

parameter_enable [int]

Enables use of this object with Max for Live Parameters and allows for setting initial parameter values in the Max environment.

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Max Mappings feature.

style [symbol] (default: )7.0.0

Sets the style to be applied to the object. Styles can be set using the Format palette.

thickness [float] (default: 50.)7.0.0

Sets the check thickness for the object.

uncheckedcolor [4 floats]7.0.0

Sets the unchecked color for the object in RGBA format. The uncheckedcolor attribute is mapped to the elementcolor style color.



Typelist (3 ints)

elementcolor is a legacy RGB alias for the uncheckedcolor RGBA attribute. See here for more information.

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:

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:


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]


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]


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]


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.

Parameter Attributes



Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable


Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name


When checked, the Scripting Name is linked to the Long Name attribute.

Long Name


The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name


Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.



Specifies the data type. The data types used in Max for Live are:

Enum (enumerated list)

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to 256 values, with a default range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values will exceed this range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.



When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Clip Modulation Mode


Sets the Clip Modulation Mode used by the Live application. The modulation modes are:


Clip Modulation Range


This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable


When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).



Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style


Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units


Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").



When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.



The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility


For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)


Speed limits values triggered by automation.

Defer Automation Output


Defers values triggered by automation.



Switches toggle on if it is off; switches it off if it is on.



input [int]
The number is sent out the outlet. If the number is not 0, toggle displays an X, showing it is on. If it is 0, toggle is blank, showing it is off.



input [float]
Converted to int. See int listing.


A mouse click on toggle switches the object on if it is off and off if it is on.


Output current value without changing state.



set-input [int]
Switches the toggle on or off without sending anything out the outlet. The word set, followed by any non-zero number, sets toggle to on; set 0 sets it to off.



A number received in the inlet is sent out the outlet. A bang or a mouse click sends 1 or 0 out the outlet, depending on whether toggle is being turned on or off.

See Also

Name Description
Max For Live Max For Live
led Color on/off button
matrixctrl Matrix switch control
pictctrl Picture-based control
radiogroup Radio button or check box
tab Tab control
textbutton Button with text
togedge Report zero/non-zero transitions
ubutton Transparent button
Max Basic Tutorial 4: Metro and Toggle Max Basic Tutorial 4: Metro and Toggle