Package Max

dict.codebox

Create and access dictionaries

Description

The dict.codebox object is a UI object for display and editing of dictionaries. Use the dict.codebox object to create named dictionaries, clone existing dictionaries, and query existing dictionaries to access their data.

Arguments

None.

Attributes

bgcolor[4 floats]

Sets the color for the object's background frame.

editlocked[int]: 0

Allow editing of the codebox text while the patcher is locked.

embed[int]

Toggles the ability to embed the contents of the text editor with the patcher. Disable to allow for display of changing text contents that will not dirty the patcher, and prompting to save.

linenumbers[int]: 1

Show lefthand column containing line numbers for non empty lines.

linenumberwidth[int32]: 20

Set the width of lefthand line number column in pixels.

margin[int32]: 4

Set the width of the left and righthand margin in pixels

style[symbol]:

Style

textcolor[4 floats]

The default textcolor (typically overridden by syntax coloring)

legacy[int]
9.0.0

When enabled (default = off), arrays returned by the get method will be output as lists, as they were previous to the introduction of the array object. New dict objects will have this attribute disabled, and will output named array objects.

name[symbol]

Name associated with the dictionary. All dictionaries are passed by reference using a symbolic name. If you do not provide a name, a unique name will be generated internally.

parameter_enable[int]

Enables use of this object with Max for Live Parameters.

parameter_mappable[int]: 1

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

quiet[int]

Reduce error checking and reporting when operations are performed on the dict. When an error occurs the result will typically be a silent failure when this option is turned-on.

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]

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.

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.

Messages

bang

Send a reference to the dictionary from the first outlet.

clear

Erase the contents of the dictionary, restoring to a clean state.

remove

Remove a key and its associated value from the dictionary.

Arguments:
  • key [symbol]

getkeys

Return a list of all the keys in a dictionary to the third outlet. By default the keys are sorted according to the order in which keys were added to the dictionary. Use the optional argument to specify alphabetical sorting.

Arguments:
  • alphabetize [bool]

contains

Return a 0 or 1 to the third outlet indicating the specified key exists (or doesn't) in the dictionary.

Arguments:
  • key [symbol]

getnames

Return a list of all the dictionaries that currently exist to the fourth outlet.

getsize

Return the number of values associated with a key to the second outlet.

Arguments:
  • key [symbol]

gettype

Return the type of the values associated with a key to the second outlet.

Arguments:
  • key [symbol]

get

Return the value associated with a key to the second outlet.

Arguments:
  • key [symbol]

set

Set the value for a key to a specified value.

Arguments:
  • key [symbol]
  • value [list]

append

Add values to the end of an array associated with the specified key.

Arguments:
  • key [symbol]
  • value [list]

replace

Set the value for a key to a specified value. If a heirarchy is specified for the key, and the heirarchy does not exist, then it will be created in the dictionary.

Arguments:
  • key [symbol]
  • value [list]

setparse

Set the value for a key to dictionary content defined using JSON.

Arguments:
  • key [symbol]
  • value [symbol]

parse

Replace the content of a dictionary by providing the new content as JSON.

Arguments:
  • key [symbol]
  • value [symbol]

clone

Make a clone of the incoming dictionary. If received at the first inlet, send a reference to this new clone from the first outlet. Otherwise just clone the dictionary and don't send it out.

Arguments:
  • name [symbol]

dictionary

Make a clone of the incoming dictionary. If received at the first inlet, send a reference to this new clone from the first outlet. Otherwise just clone the dictionary and don't send it out.

Arguments:
  • name [symbol]

read

Read the dictionary contents from a JSON or YAML file. If no path/filename is provided, a dialog will be presented. The file format is determined from the file name extension, either '.json' or '.yaml'. A success/failure notification will be sent to the rightmost outlet in the form read [filename] 0/1 .

Arguments:
  • filename [symbol]

readagain

re-reads an JSON or YAML file previously specified by the read or write messages. If no file has been previously specified, a standard File Dialog will be presented for the user to manually choose the file to be read. A success/failure notification will be sent to the rightmost outlet in the form read [filename] 0/1 .

import

Read the dictionary contents from a JSON or YAML file. If no path/filename is provided, a dialog will be presented. The file format is determined from the file name extension, either '.json' or '.yaml'. A success/failure notification will be sent to the rightmost outlet in the form import [filename] 0/1 .

Arguments:
  • filename [symbol]

readany

Read the dictionary contents from a JSON or YAML file. If no path/filename is provided, a dialog will be presented. The file format and extension are not checked. The contents of the file are assumed to be in JSON format. A success/failure notification will be sent to the rightmost outlet in the form read [filename] 0/1 .

Arguments:
  • filename [symbol]

write

Write the dictionary contents to a JSON or YAML file. If no path/filename is provided, a dialog will be presented. The file format is determined from the file name extension, either '.json' or '.yaml'. A success/failure notification will be sent to the rightmost outlet in the form write [filename] 0/1 .

Arguments:
  • filename [symbol]

export

Write the dictionary contents to a JSON or YAML file. If no path/filename is provided, a dialog will be presented. The file format is determined from the file name extension, either '.json' or '.yaml'. A success/failure notification will be sent to the rightmost outlet in the form export [filename] 0/1 .

Arguments:
  • filename [symbol]

writeagain

Write the dictionary contents to a JSON or YAML file. The file provided as an argument for the previous 'write' or 'export' message will be used. A success/failure notification will be sent to the rightmost outlet in the form write [filename] 0/1 .

(mouse)

Double-click a dict object to open a dictionary editor window.

edit

Open the dictionary editor window.

wclose

Close the dictionary editor window if it is open.

pull_from_coll

Pull the content of a named coll object into the dictionary. The indices in the coll will become the keys, and the values for those indices the values for the dictionary's keys.

Arguments:
  • coll-name [symbol]

push_to_coll

Push the dictionary's content into a named coll object. The keys in the dictionary will become the indices in the coll, and the values for those indices the values of the dictionary's keys.

Arguments:
  • coll-name [symbol]

See Also

Name Description
dict Create and access dictionaries
coll Store and edit a collection of data
coll.codebox Store and edit a collection of data
osc.codebox Display OSC packets as Dictionaries