Class TreeComponent

Base class for all Angular components in the MemberJunction system.

Hierarchy (View Summary)

BaseAngularComponent
- TreeComponent

Implements

OnInit
OnDestroy

Index

Constructors

constructor

Constructors

constructor

new TreeComponent(cdr: ChangeDetectorRef, elementRef: ElementRef): TreeComponent
Parameters
- cdr: ChangeDetectorRef
- elementRef: ElementRef
Returns TreeComponent
Overrides BaseAngularComponent.constructor
- Defined in trees/src/lib/tree/tree.component.ts:353

Properties

AfterDataLoad

AfterDataLoad: EventEmitter<AfterDataLoadEventArgs> = ...

AfterKeyboardNavigate

AfterKeyboardNavigate: EventEmitter<AfterKeyboardNavigateEventArgs> = ...

AfterNodeClick

AfterNodeClick: EventEmitter<AfterNodeClickEventArgs> = ...

AfterNodeCollapse

AfterNodeCollapse: EventEmitter<AfterNodeCollapseEventArgs> = ...

AfterNodeDeselect

AfterNodeDeselect: EventEmitter<AfterNodeDeselectEventArgs> = ...

AfterNodeDoubleClick

AfterNodeDoubleClick: EventEmitter<AfterNodeDoubleClickEventArgs> = ...

AfterNodeExpand

AfterNodeExpand: EventEmitter<AfterNodeExpandEventArgs> = ...

AfterNodeSelect

AfterNodeSelect: EventEmitter<AfterNodeSelectEventArgs> = ...

AllBranches

AllBranches: TreeNode[] = []

All branch nodes (flat)

AllLeaves

AllLeaves: TreeNode[] = []

All leaf nodes (flat)

BeforeDataLoad

BeforeDataLoad: EventEmitter<BeforeDataLoadEventArgs> = ...

BeforeKeyboardNavigate

BeforeKeyboardNavigate: EventEmitter<BeforeKeyboardNavigateEventArgs> = ...

BeforeNodeClick

BeforeNodeClick: EventEmitter<BeforeNodeClickEventArgs> = ...

BeforeNodeCollapse

BeforeNodeCollapse: EventEmitter<BeforeNodeCollapseEventArgs> = ...

BeforeNodeDeselect

BeforeNodeDeselect: EventEmitter<BeforeNodeDeselectEventArgs> = ...

BeforeNodeDoubleClick

BeforeNodeDoubleClick: EventEmitter<BeforeNodeDoubleClickEventArgs> = ...

BeforeNodeExpand

BeforeNodeExpand: EventEmitter<BeforeNodeExpandEventArgs> = ...

BeforeNodeSelect

BeforeNodeSelect: EventEmitter<BeforeNodeSelectEventArgs> = ...

CurrentSearchText

CurrentSearchText: string = ''

Current search text (for highlighting)

DefaultExpansion

DefaultExpansion: "none" | "first-level" | "all" = 'first-level'

Initial expansion applied when ExpandedIDs is null: 'first-level' (default) expands only the root branches, 'all' expands every branch (small pickers where the whole catalog should be visible), 'none' starts fully collapsed.

ErrorMessage

ErrorMessage: string | null = null

Error message if load failed

FocusedNode

FocusedNode: TreeNode | null = null

Currently focused node (for keyboard navigation)

IsLoaded

IsLoaded: boolean = false

Has data been loaded

IsLoading

IsLoading: boolean = false

Loading state

Nodes

Nodes: TreeNode[] = []

Root nodes of the tree

Provider

Provider: IMetadataProvider | null

If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

SelectedNodes

SelectedNodes: TreeNode[] = []

Currently selected nodes

SelectionChange

SelectionChange: EventEmitter<TreeNode[]> = ...

Emitted when selection changes (convenience event with just the selected nodes)

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

"ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

Accessors

AnimateExpandCollapse

get AnimateExpandCollapse(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:277
set AnimateExpandCollapse(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:274

AutoLoad

get AutoLoad(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:237
set AutoLoad(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:234

BranchConfig

get BranchConfig(): TreeBranchConfig
Returns TreeBranchConfig
- Defined in trees/src/lib/tree/tree.component.ts:76
set BranchConfig(value: TreeBranchConfig): void
Parameters
- value: TreeBranchConfig
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:65

EmptyIcon

get EmptyIcon(): string
Returns string
- Defined in trees/src/lib/tree/tree.component.ts:227
set EmptyIcon(value: string): void
Parameters
- value: string
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:224

EmptyMessage

get EmptyMessage(): string
Returns string
- Defined in trees/src/lib/tree/tree.component.ts:217
set EmptyMessage(value: string): void
Parameters
- value: string
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:214

EnableKeyboardNavigation

get EnableKeyboardNavigation(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:167
set EnableKeyboardNavigation(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:164

ExpandedIDs

get ExpandedIDs(): string[] | null
Returns string[] | null
- Defined in trees/src/lib/tree/tree.component.ts:139
set ExpandedIDs(value: string[] | null): void
Parameters
- value: string[] | null
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:136

IndentSize

get IndentSize(): number
Returns number
- Defined in trees/src/lib/tree/tree.component.ts:197
set IndentSize(value: number): void
Parameters
- value: number
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:194

KeyboardConfig

get KeyboardConfig(): TreeKeyboardConfig
Returns TreeKeyboardConfig
- Defined in trees/src/lib/tree/tree.component.ts:177
set KeyboardConfig(value: TreeKeyboardConfig): void
Parameters
- value: TreeKeyboardConfig
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:174

LeafConfig

get LeafConfig(): TreeLeafConfig | undefined
Returns TreeLeafConfig | undefined
- Defined in trees/src/lib/tree/tree.component.ts:94
set LeafConfig(value: TreeLeafConfig | undefined): void
Parameters
- value: TreeLeafConfig | undefined
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:83

ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

Returns IMetadataProvider
Inherited from BaseAngularComponent.ProviderToUse
- Defined in base-types/dist/base-angular-component.d.ts:17

RunQueryToUse

get RunQueryToUse(): IRunQueryProvider
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

Returns IRunQueryProvider
Inherited from BaseAngularComponent.RunQueryToUse
- Defined in base-types/dist/base-angular-component.d.ts:25

RunViewToUse

get RunViewToUse(): IRunViewProvider
Returns either the default RunView provider or the one specified in the Provider property, if it was specified

Returns IRunViewProvider
Inherited from BaseAngularComponent.RunViewToUse
- Defined in base-types/dist/base-angular-component.d.ts:21

SelectableTypes

get SelectableTypes(): TreeSelectableTypes
Returns TreeSelectableTypes
- Defined in trees/src/lib/tree/tree.component.ts:114
set SelectableTypes(value: TreeSelectableTypes): void
Parameters
- value: TreeSelectableTypes
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:111

SelectedIDs

get SelectedIDs(): string[]
Returns string[]
- Defined in trees/src/lib/tree/tree.component.ts:129
set SelectedIDs(value: string[]): void
Parameters
- value: string[]
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:121

SelectionMode

get SelectionMode(): TreeSelectionMode
Returns TreeSelectionMode
- Defined in trees/src/lib/tree/tree.component.ts:104
set SelectionMode(value: TreeSelectionMode): void
Parameters
- value: TreeSelectionMode
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:101

ShowBadges

get ShowBadges(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:267
set ShowBadges(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:264

ShowDescriptions

get ShowDescriptions(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:257
set ShowDescriptions(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:254

ShowExpandCollapseAll

get ShowExpandCollapseAll(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:157
set ShowExpandCollapseAll(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:154

ShowIcons

get ShowIcons(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:247
set ShowIcons(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:244

ShowLoading

get ShowLoading(): boolean
Returns boolean
- Defined in trees/src/lib/tree/tree.component.ts:207
set ShowLoading(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:204

StyleConfig

get StyleConfig(): TreeStyleConfig
Returns TreeStyleConfig
- Defined in trees/src/lib/tree/tree.component.ts:187
set StyleConfig(value: TreeStyleConfig): void
Parameters
- value: TreeStyleConfig
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:184

Methods

ClearCache

ClearCache(): void
Clear cache (call before Refresh if you want fresh data)

Returns void
- Defined in trees/src/lib/tree/tree.component.ts:559

ClearSelection

ClearSelection(): void
Clear selection

Returns void
- Defined in trees/src/lib/tree/tree.component.ts:440

CollapseAll

CollapseAll(): void
Collapse all nodes

Returns void
- Defined in trees/src/lib/tree/tree.component.ts:460

ExpandAll

ExpandAll(): void
Expand all nodes

Returns void
- Defined in trees/src/lib/tree/tree.component.ts:452

ExpandToNode

ExpandToNode(id: string): TreeNode | null
Expand to specific node (expands all ancestors)
Parameters
- id: string
Returns TreeNode | null
- Defined in trees/src/lib/tree/tree.component.ts:468

FilterNodes

FilterNodes(
    searchText: string,
    options?: {
        caseSensitive?: boolean;
        searchBranches?: boolean;
        searchDescription?: boolean;
        searchLeaves?: boolean;
    },
): TreeNode[]
Filter nodes by search text
Parameters
- searchText: string
- options: {
      caseSensitive?: boolean;
      searchBranches?: boolean;
      searchDescription?: boolean;
      searchLeaves?: boolean;
  } = {}
Returns TreeNode[]
- Defined in trees/src/lib/tree/tree.component.ts:509

FindNode

FindNode(id: string): TreeNode | null
Find node by ID
Parameters
- id: string
Returns TreeNode | null
- Defined in trees/src/lib/tree/tree.component.ts:489

FindNodes

FindNodes(predicate: (node: TreeNode) => boolean): TreeNode[]
Get all nodes matching a predicate
Parameters
- predicate: (node: TreeNode) => boolean
Returns TreeNode[]
- Defined in trees/src/lib/tree/tree.component.ts:496

getContainerClasses

getContainerClasses(): Record<string, boolean>
Get container classes

Returns Record<string, boolean>
- Defined in trees/src/lib/tree/tree.component.ts:1785

getHighlightedLabel

getHighlightedLabel(node: TreeNode): string
Get label HTML with search text highlighted
Parameters
- node: TreeNode
Returns string
- Defined in trees/src/lib/tree/tree.component.ts:1804

getNodeClasses

getNodeClasses(node: TreeNode): Record<string, boolean>
Get CSS classes for a node
Parameters
- node: TreeNode
Returns Record<string, boolean>
- Defined in trees/src/lib/tree/tree.component.ts:1763

getNodePadding

getNodePadding(node: TreeNode): string
Get the padding for a node based on its level
Parameters
- node: TreeNode
Returns string
- Defined in trees/src/lib/tree/tree.component.ts:1750

GetSelectedIDs

GetSelectedIDs(): string[]
Get selected IDs

Returns string[]
- Defined in trees/src/lib/tree/tree.component.ts:396

GetSelectedNodes

GetSelectedNodes(): TreeNode[]
Get currently selected nodes

Returns TreeNode[]
- Defined in trees/src/lib/tree/tree.component.ts:389

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in trees/src/lib/tree/tree.component.ts:370

ngOnInit

ngOnInit(): void
A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns void
Implementation of OnInit.ngOnInit
- Defined in trees/src/lib/tree/tree.component.ts:363

onKeyDown

onKeyDown(event: KeyboardEvent): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:637

onNodeClick

onNodeClick(node: TreeNode, event: MouseEvent): void
Handle node click
Parameters
- node: TreeNode
- event: MouseEvent
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:570

onNodeDoubleClick

onNodeDoubleClick(node: TreeNode, event: MouseEvent): void
Handle node double-click
Parameters
- node: TreeNode
- event: MouseEvent
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:605

onToggleClick

onToggleClick(node: TreeNode, event: MouseEvent): void
Handle toggle click
Parameters
- node: TreeNode
- event: MouseEvent
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:627

Refresh

Refresh(): Promise<void>
Reload tree data (forces fresh load from database)

Returns Promise<void>
- Defined in trees/src/lib/tree/tree.component.ts:381

SelectNodes

SelectNodes(ids: string[], emitChange?: boolean): void
Programmatically select node(s)
Parameters
- ids: string[]
- emitChange: boolean = true
  Whether to emit SelectionChange event (default: true). Set to false during sync operations to avoid unnecessary events.
Returns void
- Defined in trees/src/lib/tree/tree.component.ts:405

trackNode

trackNode(index: number, node: TreeNode): string
Track nodes for ngFor
Parameters
- index: number
- node: TreeNode
Returns string
- Defined in trees/src/lib/tree/tree.component.ts:1797

Class TreeComponent

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TreeComponent

Properties

AfterDataLoad

AfterKeyboardNavigate

AfterNodeClick

AfterNodeCollapse

AfterNodeDeselect

AfterNodeDoubleClick

AfterNodeExpand

AfterNodeSelect

AllBranches

AllLeaves

BeforeDataLoad

BeforeKeyboardNavigate

BeforeNodeClick

BeforeNodeCollapse

BeforeNodeDeselect

BeforeNodeDoubleClick

BeforeNodeExpand

BeforeNodeSelect

CurrentSearchText

DefaultExpansion

ErrorMessage

FocusedNode

IsLoaded

IsLoading

Nodes

Provider

SelectedNodes

SelectionChange

Staticɵdir

Staticɵfac

Accessors

AnimateExpandCollapse

Returns boolean

Parameters

Returns void

AutoLoad

Returns boolean

Parameters

Returns void

BranchConfig

Returns TreeBranchConfig

Parameters

Returns void

EmptyIcon

Returns string

Parameters

Returns void

EmptyMessage

Returns string

Parameters

Returns void

EnableKeyboardNavigation

Returns boolean

Parameters

Returns void

ExpandedIDs

Returns string[] | null

Parameters

Returns void

IndentSize

Returns number

Parameters

Returns void

KeyboardConfig

Returns TreeKeyboardConfig

Parameters

Returns void

`Static`ɵdir

`Static`ɵfac