class Dict

Bind to a Max dict object.

The Dict object lets you access structured data (a dictionary) associated with a name. If there is a named dict object in Max, it will share its contents with the JavaScript Dict object of the same name.

Index

Constructors

• new Dict(name)

Properties

• name
• quiet

Methods

• append(key, values)
• clear()
• clone(name)
• contains(key)
• export_json(filename)
• export_yaml(filename)
• freepeer()
• get(key)
• getkeys()
• getnames()
• getsize(key)
• gettype(key)
• import_json(filename)
• import_yaml(filename)
• parse(serialization)
• pull_from_coll(coll_name)
• push_to_coll(coll_name)
• readany(filename)
• remove(key)
• replace(key, value)
• set(key, value)
• setparse(key, serialization)
• stringify()
• stringify_compressed()
• stringify_unformatted()
• writeagain()

new Dict(name)

new Dict(name?: string);

Create a named dictionary

If no name is provided as an argument then a unique name will be generated for the dictionary.

append(key, values)

Add values to the associated data

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

append(key: string, ...values: any[]): void;

clear()

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

clear(): void;

clone(name)

Copy the named dictionary into this dictionary

clone(name: string): void;

Example

var d1 = new Dict("one");
var d2 = new Dict("two");

d1.clone("two"); // Copies the dictionary named "two" into d1

contains(key)

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

contains(key: string): number;

export_json(filename)

Write a file in the JSON format.

export_json(filename: string): void;

export_yaml(filename)

Write a file in the YAML format.

export_yaml(filename: string): void;

freepeer()

Free the native C peer

Frees the dictionary data from the native C peer (created when making a Dict object), which is not considered by the JavaScript garbage collector, and may consume lots of memory until the garbage collector decides to run based JS allocated memory. Once called, the Dict object is not available for any other use. It's not necessary to call this function, as the memory will be freed eventually, but you can call it whenever you're done with your Dict object.

freepeer(): void;

get(key)

Return the value associated with a key.

get(key: string): any;

getkeys()

Return a list of all the keys in a dictionary, or null if the dictionary contains no keys.

getkeys(): string[] | null;

getnames()

List of all named dictionaries.

Return a list of all the dictionary names that are known to Max.

getnames(): string[];

getsize(key)

Length of the array of values associated with a key.

getsize(key: string): number;

gettype(key)

Type of the value or values associated with a key.

gettype(key: string): string;

import_json(filename)

Read a file in the JSON format.

import_json(filename: string): void;

import_yaml(filename)

Read a file in the YAML format.

import_yaml(filename: string): void;

name string

The name of the dictionary

parse(serialization)

Parse a serialized dictionary and replace contents

Replaces the contents of the dictionary by parsing a dictionary serialization. Understands JSON and Max Dictionary Syntax

parse(serialization: string): void;

pull_from_coll(coll_name)

Pull data from a named coll object

Adds entries to the dictionary by pulling rows from the given coll object. Does not clear existing keys from the dictionary.

pull_from_coll(coll_name: string): void;

push_to_coll(coll_name)

Pull data into a named coll object

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.

push_to_coll(coll_name: string): void;

quiet boolean

Suppresses many errors or warnings if set to true

readany(filename)

Loads the contents of a file.

Replaced the contents of the dictionary, clearing existing keys. Accepts JSON and YAML files.

readany(filename: string): void;

remove(key)

Remove a key and its associated value from the dictionary.

remove(key: string): void;

replace(key, value)

Set the value for a key to a specified value, creating a nested dicts if necessary.

Unlike Dict.set(), this function will create a hierarchical path to a given value if one does not already exist.

replace(key: string, ...value: any[]): void;

Example

var d = new Dict(); // empty dictionary
d.replace("first::second::third", 42);
post(d.get("first").get("second").get("third")); // 42

set(key, value)

Set the value for a key to a specified value.

Unlike Dict.replace(), will not create nested dictionaryies if the nested structure does not already exist.

set(key: string, ...value: any[]): void;

setparse(key, serialization)

Set the value for a key using a serialized dictionary

The serialization can be formatted as JSON or as Max Dictionary Syntax

setparse(key: string, serialization: string): void;

stringify()

Return the content of the dictionary as a JSON string.

stringify(): string;

stringify_compressed()

Return the content of the dictionary as a compressed JSON string.

stringify_compressed(): string;

stringify_unformatted()

Return the content of the dictionary as an unformatted JSON string.

stringify_unformatted(): string;

writeagain()

Open a save dialog to write the dictionary contents to a file.

writeagain(): void;