Class TreeWidget

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

Hierarchy (View Summary)

Widget
- TreeWidget

Index

Constructors

Properties

arrowRef contentRef headerRef listeners ref titleRef view

Methods

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

Constructors

constructor

new TreeWidget(title?: string, expanded?: boolean): TreeWidget
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
- Optionaltitle: string = ''
  The title of the tree.
- Optionalexpanded: boolean = false
  Whether the tree is expanded.
Returns TreeWidget
Overrides Widget.constructor
- Defined in widgets/TreeWidget.ts:24

Properties

arrowRef

arrowRef: HTMLSpanElement

contentRef

contentRef: HTMLDivElement

headerRef

headerRef: HTMLDivElement

listeners

listeners: { [key: string]: EventCallback[] }

ref

ref: HTMLDivElement

titleRef

titleRef: HTMLSpanElement

view

view: View

Methods

_init

_init(): void
Do the necessary initialization.

Returns void
Inherited from Widget._init
- Defined in widgets/GUIElement.ts:19

addClass

addClass(...classes: string[]): this
Add one or more classes to an element.
Parameters
- ...classes: string[]
Returns this
Inherited from Widget.addClass
- Defined in widgets/GUIElement.ts:28

append

append(widget: Widget): this
Add a child widget to the tree.
Parameters
- widget: Widget
Returns this
- Defined in widgets/TreeWidget.ts:122

collapse

collapse(): this
Collapse the tree.

Returns this
- Defined in widgets/TreeWidget.ts:94

destroy

destroy(): void
Destroy the element

Returns void
Inherited from Widget.destroy
- Defined in widgets/GUIElement.ts:53

expand

expand(): this
Expand the tree.

Returns this
- Defined in widgets/TreeWidget.ts:103

getConfig

getConfig(): object
The getConfig function returns a JSON representation of all values in the tree.

Returns object
- Defined in widgets/TreeWidget.ts:143

getRef

getRef(): HTMLElement | null
Returns HTMLElement | null
Inherited from Widget.getRef
- Defined in widgets/GUIElement.ts:46

initToggleOnClick

initToggleOnClick(): void
Returns void
- Defined in widgets/TreeWidget.ts:127

loadConfig

loadConfig(config: object): TreeWidget
The loadConfig function loads a JSON object into the tree.
Parameters
- config: object
Returns TreeWidget
- Defined in widgets/TreeWidget.ts:151

off

off(event: string, callback: EventCallback): void
Parameters
- event: string
- callback: EventCallback
Returns void
Inherited from Widget.off
- Defined in EventSupport.ts:18

on

on(event: string, callback: EventCallback): void
Parameters
- event: string
- callback: EventCallback
Returns void
Inherited from Widget.on
- Defined in EventSupport.ts:13

onClick

onClick(f: () => void): this
Add a click event listener to the widget.
Parameters
- f: () => void
  The function to call when the widget is clicked.
Returns this
Inherited from Widget.onClick
- Defined in widgets/Widget.ts:49

removeClass

removeClass(...classes: string[]): this
Remove one or more classes from an element.
Parameters
- ...classes: string[]
Returns this
Inherited from Widget.removeClass
- Defined in widgets/GUIElement.ts:38

setContent

setContent(html: string): this
Set the content of the tree.
Parameters
- html: string
Returns this
Overrides Widget.setContent
- Defined in widgets/TreeWidget.ts:85

setText

setText(value: string): this
Set the text of the widget.
Parameters
- value: string
  The value to set the text to.
Returns this
Inherited from Widget.setText
- Defined in widgets/Widget.ts:39

setTitle

setTitle(html: string): this
Set the title of the tree.
Parameters
- html: string
Returns this
- Defined in widgets/TreeWidget.ts:75

toggle

toggle(): this
Toggle the tree between collapsed and expanded.

Returns this
- Defined in widgets/TreeWidget.ts:112

trigger

trigger(event: string, ...args: any[]): void
Parameters
- event: string
- ...args: any[]
Returns void
Inherited from Widget.trigger
- Defined in EventSupport.ts:24