Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AbstractTreeComponent
    • TreeComponent

Index

Constructors

Properties

_treeService: CaseTreeService
treeRootAddingChild: EventEmitter<boolean>

true is emitted whenever the tree's root node is adding a new child node.

false is emitted when the root node is no longer adding a new child node.

The first value emitted from this Output is false, when the tree finishes initializing.

No further calls to add a child node should be made, while a child is being added.

treeRootLoading: EventEmitter<boolean>

true is emitted whenever the tree's root node is in it's loading state.

false is emitted when the root node is no longer in the loading state.

The first value emitted from this Output is false, when the tree finishes initializing.

The root node enters it's loading state when it's children are being loaded.

ɵcmp: unknown
ɵfac: unknown

Accessors

  • set eagerLoaded(eager: boolean): void
  • Weather the tree is eager loaded or not.

    Defaults to false.

    It is not recommended to eager load large trees as each node sends a separate backend request to load its data.

    Parameters

    • eager: boolean

      the new setting for eager loading

    Returns void

  • set filter(filter: Filter): void
  • The {@link Filter} that determines the root node of the tree.

    The tree can only have one root. If more than one case is returned by the Filter. The first result will be used as the tree root.

    If you want to have multiple nodes in the first level checkout the [showTreeRoot]{@link AbstractTreeComponent#showTreeRoot} property.

    Parameters

    • filter: Filter

      Case Filter that determines the tree root

    Returns void

  • set showTreeRoot(showTreeRoot: boolean): void
  • Whether the tree root should be displayed as a node or not.

    true displays the root as the only node in the first level.

    false displays the root's child nodes in the first level.

    If you want to add more children while the root is hidden use the [addRootChildNode] {@link AbstractTreeComponent#addRootChildNode} method.

    Parameters

    • showTreeRoot: boolean

      whether the root node should be displayed in the tree or not

    Returns void

Methods

  • addRootChildNode(): void
  • Adds a child to the root node.

    Useful if you set the [showTreeRoot]{@link AbstractTreeComponent#showTreeRoot} property to false.

    Returns void

  • expandPath(path: CaseTreePath): void
  • Expands all nodes in the tree dictated by the argument.

    Parameters

    • path: CaseTreePath

      nodes that should be expanded along with their path from the root node

    Returns void

Generated using TypeDoc