A Collection Object gives an API for locating multiple instances of an AxiomObject in one location. For example, the _children property on an AxiomObject is a Collection, but is not the only Collection that an object can have. Note that no object can belong to more than one collection!
Contents |
Collection.length
Description
Collection.length
(Number) - The number of Axiom Objects the current Collection has.
Collection.add()
Description
Collection.add(object)
Parameters
- object (AxiomObject) - The Axiom Object to add to the Collection.
Also See...
Collection.get()
Description
Collection.get(accessname)
Retrieves the Axiom Object with the specified accessname from the Collection.
Parameters
- accessname (String) - The accessname of the Axiom Object to retrieve.
Returns
(AxiomObject) - The Axiom Object with the specified accessname from the Collection.
Also See...
Collection.getById()
Description
Collection.getById(id)
Retrieves the Axiom Object with the specified _id from the Collection.
Parameters
- id (Number) - The _id number for Axiom Object to retrieved.
Returns (AxiomObject) - The Axiom Object with the specified _id from the Collection.
Also See...
Collection.remove()
Description
Collection.remove(object)
Removes the specified Axiom Object from the Collection.
Parameters
- object (AxiomObject) - The Axiom Object to remove.
Notes Removing a node also deletes it permanently from the data store.
Also See...