Class: Resource

// To use a resource without an ObjectNode, first create the resource.
const xebraState; // Instance of Xebra.State
const resource = xebraState.createResource();

// The resource doesn't hold on to data from Max once it receives it, so be sure to listen for Resource.event:data_received
// events in order to handle resource data.
resource.on("data_received", (filename, data_uri) => {
// Do something with the data
});

// Setting the filename property will cause the Resource object to fetch the data from Max. filename should be the
// name of a file in Max's search path. If Max is able to load the file successfully, it will send the data back
// to the Resource object, which will fire a Resource.event:data_received event with the data and filename.
resource.filename = "alex.png";

// If the requested file is an .svg file, then Max will render the file before sending the data back to the Resource
// object. In this case, the dimensions property of the resource must be set as well as filename.
resource.filename = "maxelement.svg";
resource.dimensions = {width: 100, height: 50};

Extends

• EventEmitter

Members

dimensions:ResourceDimensions

Dimensions of the resource. These are not updated automatically, and cannot be used to determine the dimensions of a raster image in Max's filepath. Instead, use the data URI returned with the Resource.event:data_received event to determine size. Setting these dimensions will trigger a new data fetch, if the resource is an .svg image. Max will be used to render the image and a .png data-uri will be returned.

filename:string

Name of a file in Max's search path. Setting this will query Max for data from the corresponding file. Listen to the Resource.event:data_received event for the data in the form of a data-uri string.

id:Xebra.NodeId

readonly

Unique identifier associated with each resource.

isSVG:boolean

readonly

Whether the resource is a SVG image or not

objectContext:Xebra.NodeId

Id of the ObjectNode that owns the resource. If the resource is not bound to an ObjectNode, returns null. Max can use the object id to augment the search path with the parent patcher of the object, if the object id is supplied.

Methods

destroy()

lib/resource.js, line 152

Be sure to call this when the Resource is no longer needed.

Events

Resource.event:data_received

lib/resource.js, line 181

Name	Type	Description
name	string	name of the resource
datauri	string	data-uri representation of the resource