Skip to content

Treebeard API

Jump to bottom Edit New page
caneruguz edited this page Oct 23, 2014 · 1 revision

In some of the event hooks you will have access to the Treebeard controller functions through this. The following function for example has the controller passed as this:

options = {
// ...
            onfilter : function(filterText){   // Fires on keyup when filter text is changed.
                // this = treebeard object;
                // filterText = the value of the filtertext input box.
                console.log("on filter: this", this, 'filterText', filterText);
            },
//...

this includes all the Treebeard methods and variables available to you. Details on what they do and how you can use them are below:

Methods

this.redraw()

If you make any changes to the tree folder structure you need to run this for the view to refresh. Changes include moving, adding or deleting.

this.toggle_scroll()

Hide or show the option to change between scrolling and pagination

this.go_to_page(page)

Programmatically go to any page if pagination is allowed.

this.page_down()

Go to the previous page.

this.page_up

Go to the next page .

this.toggle_paginate()

Turn pagination on or off

this.toggle_scroll()

Hide or show the option to change between scrolling and pagination

Variables

currentPage

If you are using pagination this will be the current page the user is on.

self.treeData

TODO

self.flatData

TODO

Add a custom footer

Treebeard Logo

<li><a href="https://github.com/caneruguz/treebeard/wiki/Quickstart">Quickstart</a></li>

<li>
    <a href="https://github.com/caneruguz/treebeard/wiki/Options">Options</a>

    <ul>
        <li><a href="https://github.com/caneruguz/treebeard/wiki/divID">divID</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/filesData">filesData</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/rowHeight">rowHeight</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/paginate">paginate</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/paginateToggle">paginateToggle</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/uploads">uploads</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/multiselect">multiselect</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/columnTitles">columnTitles</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/resolveRows">resolveRows</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/hoverClass">hoverClass</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/showFilter">showFilter</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/title">title</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/Drag-and-Drop-options">Drag and Drop</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/sortButtonSelector">sortButtonSelector</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/onfilter">onfilter</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/onload">onload</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/togglecheck">togglecheck</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/onfilterreset">onfilterreset</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/createcheck">createcheck</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/oncreate">oncreate</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/deletecheck">deletecheck</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/ondelete">ondelete</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/addcheck">addcheck</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/onadd">onadd</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/onselectrow">onselectrow</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/onmouseoverrow">onmouseoverrow</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/ontogglefolder">ontogglefolder</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/resolveIcon">resolveIcon</a></li>

    </ul>
</li>

<li><a href="https://github.com/caneruguz/treebeard/wiki/Item-API">Item API</a></li>

<li><a href="https://github.com/caneruguz/treebeard/wiki/Treebeard-API">Treebeard API</a></li>

<li><a href="https://github.com/caneruguz/treebeard/wiki/Modal">Modal</a></li>

<li><a href="https://github.com/caneruguz/treebeard/wiki/Notify">Notify</a></li>

<li><a href="https://github.com/caneruguz/treebeard/wiki/using-dropzone">Using Dropzone</a></li>
    <ul>
        <li><a href="https://github.com/caneruguz/treebeard/wiki/resolveUploadUrl">resolveUploadUrl</a></li>

        <li><a href="https://github.com/caneruguz/treebeard/wiki/resolveLazyloadUrl">resolveLazyloadUrl</a></li>
    </ul>
<li><a href="https://github.com/caneruguz/treebeard/wiki/Styling-the-Grid">Styling the Grid</a></li>

<li><a href="https://github.com/caneruguz/treebeard/wiki/FAQs">FAQs</a></li>

Clone this wiki locally