Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 2.75 KB

noodl-object.md

File metadata and controls

81 lines (61 loc) · 2.75 KB
Raw

Noodl.Object

Allows access to Object features from Javascript.

Noodl.Object.get(id)
Returns the object with the specified id. This function will return a new empty object if the id is not previously used. If you want to check if an object exists use the Noodl.Object.exists function.

Noodl.Object.create(data)
This function will create a new object and return it. The properties of the object will be that of the supplied data. A special case is the id attribute that will become the id of the object and not part of the object properties. E.g. the code below will create an object with two properties and the id set to 'A'.

Noodl.Object.create({
  id: 'A',
  myProp1: 10,
  myProp2: 'Hello',
  myProp3: Noodl.Object.create({ anotherProp: 15 }),
});

If no id is provided the newly created object will get a unique id assigned. As illustrated in the example above object properties can contain other objects.

Noodl.Object.exists(id)
Returns true if an object with the specified Id has been created with a call to Noodl.Object.get or Noodl.Object.create.

object.on(event,listener)
object.off(event,listener)
Add and remove an event listener from the object. Supported events:

  • change - any property of the object is changed
  • add - the object is added to a array
  • remove - the object is removed from a array.

Example usage:

myObject.on('change', function (args) {
  // property with name args.name was changed
  // new value in args.value
  // old value in args.old
});

myObject.on('add', function (args) {
  // object was added to the array args.array
});

myObject.on('remove', function (args) {
  // object was removed from the array args.array
});

object.getId()
Returns the Id of the object.

object.set(name,value,options)
Sets a property of the object. The name and value of the property should be provided to the function.

myObject.set('myProp1',44)

Optionally, dot notation can be used to set a sub property. If a property of the object is another object, then you can set a property of the object e.g. myProp3.anotherProp. To enable this you must supply the options {resolve:true}.

myObject.set('myProp3.anotherProp',50,{resolve:true})

object.setAll(data)
This function performs a set on all properties of the specified object. This is equal to calling set for all properties of the data object. Updating the id property is not supported, and will be ignored.

object.get(name,options)
Returns the value of the property with the specified name. As in the set function the dot notation can be used if the object has another object as a property, if the options {resolve:true} is supplied.

myObject.get('myProp3.anotherProp',{resolve:true})