API Docs for: 3.13.0
Show:

Tree.Node.Selectable Class

Defined in: tree/js/extensions/tree-node-selectable.js:6
Module: tree-selectable
Parent Module: tree

Tree.Node extension that adds methods useful for nodes in trees that use the Tree.Selectable extension.

Constructor

Tree.Node.Selectable

()

Defined in tree/js/extensions/tree-node-selectable.js:6

Item Index

Methods

Methods

isSelected

() Boolean

Defined in tree/js/extensions/tree-node-selectable.js:18

Returns true if this node is currently selected.

Returns:

Boolean:

true if this node is currently selected, false otherwise.

select

(
  • [options]
)
chainable

Defined in tree/js/extensions/tree-node-selectable.js:29

Selects this node.

Parameters:

  • [options] Object optional

    Options.

    • [silent=false] Boolean optional

      If true, the select event will be suppressed.

    • [src] String optional

      Source of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.

unselect

(
  • [options]
)
chainable

Defined in tree/js/extensions/tree-node-selectable.js:47

Unselects this node.

Parameters:

  • [options] Object optional

    Options.

    • [silent=false] Boolean optional

      If true, the unselect event will be suppressed.

    • [src] String optional

      Source of the change, to be passed along to the event facade of the resulting event. This can be used to distinguish between changes triggered by a user and changes triggered programmatically, for example.