PUBLIC_FUNCTIONS.md

Tree.js - Functions:

Below is a list of all the public functions that can be called from the Tree.js instance.

Manage Instances:

refresh( elementId ):

Refreshes a Tree.js instance.
Fires: onRefresh
Parameter: elementId: 'string' - The Tree.js element ID that should be refreshed.
Returns: 'Object' - The Tree.js class instance.

refreshAll():

Refreshes all of the rendered Tree.js instances.
Fires: onRefresh
Returns: 'Object' - The Tree.js class instance.

moveToPreviousCategory( elementId ):

Moves to the previous category.
Fires: onBackCategory
Parameter: elementId: 'string' - The Tree.js element ID that should be updated.
Returns: 'Object' - The Tree.js class instance.

moveToNextCategory( elementId ):

Moves to the next category.
Fires: onNextCategory
Parameter: elementId: 'string' - The Tree.js element ID that should be updated.
Returns: 'Object' - The Tree.js class instance.

Configuration:

setConfiguration( newConfiguration ):

Sets the specific configuration options that should be used.
Parameter: newConfiguration: 'Options' - All the configuration options that should be set (refer to "Configuration Options" documentation for properties).
Returns: 'Object' - The Tree.js class instance.

Additional Data:

getIds():

Returns an array of element IDs that have been rendered.
Returns: 'string[]' - The element IDs that have been rendered.

getVersion():

Returns the version of Tree.js.
Returns: 'string' - The version number.

Example:

<script> 
    var version = $tree.getVersion();
</script>