Package Jitter Tools

jit.ui.number

An interactive flonum in the rendering window

Description

Use the widgets to move and resize this UI object in the rendering window using the mouse.

Arguments

None.

Attributes

background_color[4 floats]

Color of main body of the UI object (default = 0.7 0.7 0.7 1.)

border[int]

Enable border around the UI object (default = 1)

border_color[4 floats]

Color of border around the UI object (default = 0. 0. 0. 1.)

border_size[float]

Size of border around the UI object in pixels

canvas[symbol]

Name of jit.ui.canvas to draw to
jit.ui objects always need the canvas attribute set, unless they are attache to a jit.ui.group object.
In this case, they will inherit the canvas attribute of the group.

constant_pixel_size[int]

Maintain consistent pixel size regardless of rendering window size (default = 1).
When enabled, the UI object retains its pixel dimensions even if the rendering window is resized.

enable[int]

Enable flag (default = 1)
When the flag is set, drawing is enabled.

enable_label[int]

Enable label text (default = 1)
When the flag is set, the label text is shown.

enable_mouse_editing[int]

Enable mouse editing (default = 1)
When enabled and the patch is unlocked, the UI object can be resized and moved with the mouse.

font[symbol]

Font name

fontsize[float]

Font size

group[symbol]

Name of assigned jit.ui.group object
When set, this UI object will be assigned to that jit.ui.group

height[int]

Height of the UI object in pixels

hide_background[int]

Hide UI object background (default = 0)

highlight_color[int]

Background color when the mouse hovers on the UI object (default = 0.9 0.9 0.9 1)

highlight_hover[int]

Enable highlight on hover (default = 0)
When enabled and the mouse is on top of the UI object area, the background changes to the highlight_color.

ignore_click[int]

Ignore mouse clicks (default = 0)
When set to 1, the UI object will not respond to mouse clicks unless in edit mode.

keep_in_window[int]

Prevent the UI object from moving outside the rendering window (default = 1).

label[symbol]

UI object label text

label_align[int]

Text alignment mode (default = 1 (center))

label_bold[int]

Label text bold style (default = 1)

label_color[4 floats]

Label text color (default = 1. 1. 1. 1.)

label_offset[int]

Label text offset in pixels from center of UI object

layer[int]

UI Object layer number (default = 0)

number_value[number]

Set displayed number value

number_value_color[4 floats]

UI number value color (default = 1. 1. 1. 1.)

number_value_fontsize[float]

UI number value font size

number_value_offset[2 ints]

UI number value offset in pixel from center of object

order_in_group[int]

Order index within a UI group when the group attribute is set.

position[2 ints]

UI object position in pixels
The position of the UI object is constant in relation to the position of its anchor.

position_anchor[2 ints]

UI object anchor position in pixels
The position of the UI object is always constant in relation to its anchor position. When the rendering window is resized, the anchor maintains the same position, proportion-wise, inside the rendering window, while the UI object follows its anchor.

position_anchor_percentage[2 ints]

UI object anchor position as a percentage of the rendering window size (default = 50 50)
Sets the anchor position of the UI object as a percentage of the rendering window dimensions. The UI object maintains its position relative to this anchor when the window is resized.

read_image_background[symbol]

Load an image and display it on the background of the UI object
The argument to this attribute is the path of the image.

roundness_corners[float]

Roundness of corners of the UI object (default = 0.2)

scale[float]

Uniform scale of the UI object as a single scalar number (default = 1)

shadow[int]

Enable shadow flag (default = 1)

shadow_color[4 floats]

Color of the shadow (default = 0.1 0.1 0.1 0.5)

shadow_offset[2 ints]

Shadow offset in pixels from center of object

take_row_group[int]

Occupy a full row within a UI group (default = 0)

texture_background[symbol]

Name of texture to be applied to background of the UI object (default = none)

triangle_color[4 floats]

UI number triangle color (default = 0.2 0.2 0.2 1.)

triangle_offset[2 ints]

UI number triangle offset in pixels from center of object

width[int]

Width of the UI object in pixels

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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'

hidden[int]: 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]: 0

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

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

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.

Parameter Attributes

Orderint

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 Enableint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Nameint

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

Long Namesymbol

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

Short Namesymbol

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.

Typeint

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

Float
Int
Enum (enumerated list)
Blob

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.

Range/Enumlist

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 Modeint

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

None
Unipolar
Bipolar
Additive
Absolute

Clip Modulation Rangelist

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

Initial Enableint

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

Initiallist

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

Unit Styleint

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 Unitssymbol

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").

Exponentfloat

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.

Stepsint

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 Visibilityint

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)int

Speed limits values triggered by automation.

Defer Automation Outputint

Defers values triggered by automation.

See Also

Name Description
jit.ui.canvas
jit.ui.button
jit.ui.toggle
jit.ui.slider
jit.ui.group