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.

Constructors

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.

Properties

name string

The name of the dictionary

quiet boolean

Suppresses many errors or warnings if set to true

Methods

append

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

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

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

contains(key: string): number;

export_json

Write a file in the JSON format.

export_json(filename: string): void;

export_yaml

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

Return the value associated with a key.

get(key: string): any;

getkeys

Return a list of all the keys in a dictionary.

getkeys(): string[];

getnames

List of all named dictionaries.

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

getnames(): string[];

getsize

Length of the array of values associated with a key.

getsize(key: string): number;

gettype

Type of the value or values associated with a key.

gettype(key: string): string;

import_json

Read a file in the JSON format.

import_json(filename: string): void;

import_yaml

Read a file in the YAML format.

import_yaml(filename: string): void;

parse

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

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

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;

readany

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

Remove a key and its associated value from the dictionary.

remove(key: string): void;

replace

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

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

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;

writeagain

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

writeagain(): void;