Class Tree

A tree that can be expanded and collapsed, and can also have children.

Hierarchy (view full)

Constructors

constructor

Properties

arrowRef contentRef headerRef listeners ref titleRef value view

Methods

_init addClass append bind collapse destroy expand getConfig getRef initToggleOnClick loadConfig off on onClick removeClass setContent setText setTitle toggle trigger

Constructors

constructor

  • new Tree(title?, expanded?): Tree

  • Create a new tree that can be expanded and collapsed. You can add children to the tree with the addChild method so that they appear in the tree.

    Parameters

    • Optional title: string = ''

      The title of the tree.

    • Optional expanded: boolean = false

      Whether the tree is expanded.

    Returns Tree

Properties

arrowRef

arrowRef: HTMLSpanElement

contentRef

contentRef: HTMLDivElement

headerRef

headerRef: HTMLDivElement

listeners

listeners: {
    [key: string]: Function[];
}

Type declaration

  • [key: string]: Function[]

ref

ref: HTMLDivElement

titleRef

titleRef: HTMLSpanElement

value

value: any

view

view: View

Methods

_init

addClass

append

bind

collapse

destroy

expand

getConfig

  • getConfig(): object

  • The getConfig function returns a JSON representation of all values in the tree.

    Returns object

getRef

initToggleOnClick

loadConfig

  • loadConfig(config): Tree

  • The loadConfig function loads a JSON object into the tree.

    Parameters

    • config: object

    Returns Tree

off

on

  • on(event, callback): void

  • Parameters

    • event: string
    • callback: Function

    Returns void

onClick

  • onClick(f): this

  • Add a click event listener to the widget.

    Parameters

    • f: Function

      The function to call when the widget is clicked.

    Returns this

removeClass

setContent

setText

  • setText(value): this

  • Set the text of the widget.

    Parameters

    • value: string

      The value to set the text to.

    Returns this

setTitle

  • setTitle(html): this

  • Set the title of the tree.

    Parameters

    • html: string

    Returns this

toggle

  • toggle(): this

  • Toggle the tree between collapsed and expanded.

    Returns this

trigger

Settings

Member Visibility

Theme

On This Page

constructorarrowRefcontentRefheaderReflistenersreftitleRefvalueview_initaddClassappendbindcollapsedestroyexpandgetConfiggetRefinitToggleOnClickloadConfigoffononClickremoveClasssetContentsetTextsetTitletoggletrigger