Class TreeDataSource<Data, RootParameters, NodeParameters>

Type Parameters

Data extends WithIdentifier & WithChildren = any
RootParameters = any
NodeParameters = any

Hierarchy

BaseDataSource<Node<Data>[], TreeDataSourceMetadata>
- TreeDataSource

Implements

OnInit

Index

Constructors

constructor

Accessors

data hasConnections id lastRefreshed nodeParameters

Constructors

constructor

new TreeDataSource<
    Data extends unknown = any,
    RootParameters = any,
    NodeParameters = any,
>(
    rootRemoteMethod: Method<Data | Data[], RootParameters>,
    childrenRemoteMethod?: null | Method<Data[], Node<Data, any>>,
    applyFilterMethod?:
        | null
        | Method<
            Node<Data, any>[],
            TreeApplyFilterParameter<ISearchForm<unknown>, any>,
        >,
    metadata?: null | TreeDataSourceMetadata,
): TreeDataSource<Data, RootParameters, NodeParameters>
Type Parameters
- Data extends unknown = any
- RootParameters = any
- NodeParameters = any
Parameters
- rootRemoteMethod: Method<Data | Data[], RootParameters>
- childrenRemoteMethod: null | Method<Data[], Node<Data, any>> = null
- applyFilterMethod:
      | null
      | Method<
          Node<Data, any>[],
          TreeApplyFilterParameter<ISearchForm<unknown>, any>,
      > = null
- metadata: null | TreeDataSourceMetadata = null
Returns TreeDataSource<Data, RootParameters, NodeParameters>
Overrides BaseDataSource<Array<Node<Data>>, TreeDataSourceMetadata>.constructor
- Defined in tree/src/lib/tree.data-source.ts:258

Properties

`Internal`__id

__id: string = ...

unique internal id

`Protected`_connectedViewer

_connectedViewer: Map<string, Observable<Node<Data, any>[]>> = ...

`Protected`_connectedViewerTeardown

_connectedViewerTeardown: Map<string, TeardownLogic> = ...

`Protected` `Optional`_data

_data?: Node<Data, any>[]

`Protected`_data$

_data$: BehaviorSubject<Node<Data, any>[]> = ...

`Protected`_initialised

_initialised: boolean = false

`Protected`_lastRefreshed

_lastRefreshed: null | Date = null

`Protected`_retry$

_retry$: Subject<void> = ...

`Protected`_viewerIds

_viewerIds: Map<BaseDataSourceViewer<any>, string> = ...

a map of viewer to view id. Allows to create a view id from the viewer object reference

`Readonly`change$

change$: Subject<Node<Data, any>[]> = ...

`Readonly`childrenRemoteMethod

childrenRemoteMethod: null | Method<Data[], Node<Data, any>> = null

`Readonly`destroyed$

destroyed$: undefined | Subject<void> = ...

Emits if the data source is destroyed

`Readonly`error$

error$: ReplaySubject<Error> = ...

expanded

expanded: SelectionModel<string>

getIcon

getIcon: NodeGetIconFunction<Data> = ...

getStyle

getStyle: NodeGetStyleFunction<Data> = ...

getType

getType: NodeGetTypeFunction<Data> = ...

hasDetails

hasDetails: NodeHasDetailsFunction<Data> = ...

`Optional`hasError

hasError?: Signal<boolean>

`Readonly`hasError$

hasError$: ToggleSubject = ...

`Readonly`initialised$

initialised$: undefined | Subject<void> = ...

Emits if the data source is initialised

`Readonly`interceptors

interceptors: undefined | Set<Subject<any>> = ...

`Optional`loading

loading?: Signal<boolean>

loading$

loading$: ToggleSubject = ...

Indicates weather the data source is currently loading new data

matchFilter

matchFilter: (node: Node<Data>) => boolean = ...

metadata

metadata: TreeDataSourceMetadata

`Readonly`rootRemoteMethod

rootRemoteMethod: Method<Data | Data[], RootParameters>

searchForm

searchForm: null | SearchForm<unknown> = null

selected

selected: SelectionModel<Node<Data, any>>

toDisplay

toDisplay: NodeToDisplayFunction<Data> = ...

tree$

tree$: BehaviorSubject<Node<Data, any>[]> = ...

treeControl

treeControl: FlatTreeControl<Node<Data, any>>

`Static` `Readonly`destroyed$

destroyed$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`initialised$

initialised$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`instances

instances: Map<string, BaseDefinition<BaseDefinitionMetadata>> = ...

A map of active Definition instances

Accessors

data

get data(): undefined | Data
Returns undefined | Data
Inherited from BaseDataSource.data
- Defined in data-source/src/lib/base.data-source.ts:106

hasConnections

get hasConnections(): boolean
Returns boolean
Inherited from BaseDataSource.hasConnections
- Defined in data-source/src/lib/base.data-source.ts:110

id

get id(): string
Returns string
Inherited from BaseDataSource.id
- Defined in definition/src/lib/definition.ts:87

lastRefreshed

get lastRefreshed(): null | Date
Returns null | Date
Inherited from BaseDataSource.lastRefreshed
- Defined in data-source/src/lib/base.data-source.ts:74

nodeParameters

get nodeParameters(): null | NodeParameters
Returns null | NodeParameters
- Defined in tree/src/lib/tree.data-source.ts:280
set nodeParameters(nodeParameters: null | NodeParameters): void
Parameters
- nodeParameters: null | NodeParameters
Returns void
- Defined in tree/src/lib/tree.data-source.ts:284

Methods

`Protected`_connect

_connect(
collectionViewer: Required<BaseDataSourceViewer<any>>,
): Observable<Node<Data, any>[]>
Parameters
- collectionViewer: Required<BaseDataSourceViewer<any>>
Returns Observable<Node<Data, any>[]>
Overrides BaseDataSource._connect
- Defined in tree/src/lib/tree.data-source.ts:622

`Protected`_disconnect

_disconnect(viewerId: string): void
Parameters
- viewerId: string
Returns void
Inherited from BaseDataSource._disconnect
- Defined in data-source/src/lib/base.data-source.ts:308

applyMetadata

applyMetadata(partialMetadata: Partial<TreeDataSourceMetadata>): void
Parameters
- partialMetadata: Partial<TreeDataSourceMetadata>
Returns void
Inherited from BaseDataSource.applyMetadata
- Defined in definition/src/lib/definition.ts:111

attach

attach(viewerId: string): Observable<Node<Data, any>[]>
Parameters
- viewerId: string
Returns Observable<Node<Data, any>[]>
Inherited from BaseDataSource.attach
- Defined in data-source/src/lib/base.data-source.ts:210

collapseNode

collapseNode(node: Node<Data>, options?: EventOptions): Promise<void>
Parameters
- node: Node<Data>
- Optionaloptions: EventOptions
Returns Promise<void>
- Defined in tree/src/lib/tree.data-source.ts:510

connect

connect(
viewerOrString: string | BaseDataSourceViewer<any>,
): Observable<Node<Data, any>[]>
Parameters
- viewerOrString: string | BaseDataSourceViewer<any>
Returns Observable<Node<Data, any>[]>
Inherited from BaseDataSource.connect
- Defined in data-source/src/lib/base.data-source.ts:124

derive

derive(
id: string,
metadata?: Partial<BaseDataSourceMetadata>,
): BaseDataSource<any>
Parameters
- id: string
- metadata: Partial<BaseDataSourceMetadata> = ...
Returns BaseDataSource<any>
Inherited from BaseDataSource.derive
- Defined in data-source/src/lib/base.data-source.ts:270

deselectNode

deselectNode(node: Node<Data>): Promise<void>
Parameters
- node: Node<Data>
Returns Promise<void>
- Defined in tree/src/lib/tree.data-source.ts:400

destroy

destroy(): void
Returns void
Deprecated
use ngOnDestroy instead
Overrides BaseDataSource.destroy
- Defined in tree/src/lib/tree.data-source.ts:538

disconnect

disconnect(viewerOrId: string | BaseDataSourceViewer<any>): void
Parameters
- viewerOrId: string | BaseDataSourceViewer<any>
Returns void
Inherited from BaseDataSource.disconnect
- Defined in data-source/src/lib/base.data-source.ts:225

expandNode

expandNode(node: Node<Data>, options?: EventOptions): Promise<void>
Parameters
- node: Node<Data>
- Optionaloptions: EventOptions
Returns Promise<void>
- Defined in tree/src/lib/tree.data-source.ts:405

flatTree

flatTree(tree: Node<Data>, all?: boolean): Node<Data, any>[]
Converts the tree structure into a list.
Parameters
- tree: Node<Data>
- all: boolean = false
  true - include nodes children that are not expanded
Returns Node<Data, any>[]
- Defined in tree/src/lib/tree.data-source.ts:534

`Protected`genericRetryFunction

genericRetryFunction(error: any, retryCount: number): Observable<any>
Parameters
- error: any
- retryCount: number
Returns Observable<any>
Inherited from BaseDataSource.genericRetryFunction
- Defined in data-source/src/lib/base.data-source.ts:311

getChildren

getChildren(node: Node<Data>): Promise<Data[]>
Parameters
- node: Node<Data>
Returns Promise<Data[]>
- Defined in tree/src/lib/tree.data-source.ts:445

getMetadata

getMetadata(): null | TreeDataSourceMetadata
Returns null | TreeDataSourceMetadata
Inherited from BaseDataSource.getMetadata
- Defined in definition/src/lib/definition.ts:107

getNodeById

getNodeById(id: string): null | Node<Data, any>
Parameters
- id: string
Returns null | Node<Data, any>
- Defined in tree/src/lib/tree.data-source.ts:465

getRoot

getRoot(options?: { cache?: boolean }): Promise<Data | Data[]>
Parameters
- options: { cache?: boolean } = {}
Returns Promise<Data | Data[]>
- Defined in tree/src/lib/tree.data-source.ts:453

getRootParameters

getRootParameters(options?: { cache?: boolean }): Promise<RootParameters>
Parameters
- options: { cache?: boolean } = {}
Returns Promise<RootParameters>
- Defined in tree/src/lib/tree.data-source.ts:458

getTreeRoot

getTreeRoot(options?: { cache?: boolean }): Promise<Node<Data, any>[]>
Parameters
- options: { cache?: boolean } = {}
Returns Promise<Node<Data, any>[]>
- Defined in tree/src/lib/tree.data-source.ts:326

getViewerId

getViewerId(viewer: BaseDataSourceViewer): string
Parameters
- viewer: BaseDataSourceViewer
Returns string
Inherited from BaseDataSource.getViewerId
- Defined in data-source/src/lib/base.data-source.ts:114

`Protected`handelError

handelError(error: any): void
Parameters
- error: any
Returns void
Inherited from BaseDataSource.handelError
- Defined in data-source/src/lib/base.data-source.ts:317

init

init(): void
Returns void
Inherited from BaseDataSource.init
- Defined in definition/src/lib/definition.ts:127

isConnected

isConnected(viewerOrId: string | BaseDataSourceViewer<any>): boolean
Parameters
- viewerOrId: string | BaseDataSourceViewer<any>
Returns boolean
Inherited from BaseDataSource.isConnected
- Defined in data-source/src/lib/base.data-source.ts:217

ngOnDestroy

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

Returns void
Inherited from BaseDataSource.ngOnDestroy
- Defined in definition/src/lib/definition.ts:122

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 tree/src/lib/tree.data-source.ts:289

refresh

refresh(): Promise<any>
Returns Promise<any>
Overrides BaseDataSource.refresh
- Defined in tree/src/lib/tree.data-source.ts:553

refreshMatchFilter

refreshMatchFilter(): void
Returns void
- Defined in tree/src/lib/tree.data-source.ts:549

reset

reset(): any
Returns any
Overrides BaseDataSource.reset
- Defined in tree/src/lib/tree.data-source.ts:595

retry

retry(): any
Returns any
Inherited from BaseDataSource.retry
- Defined in data-source/src/lib/base.data-source.ts:293

selectNode

selectNode(node: Node<Data>): Promise<void>
Parameters
- node: Node<Data>
Returns Promise<void>
- Defined in tree/src/lib/tree.data-source.ts:364

setGetIcon

setGetIcon(getIcon?: NodeGetIconFunction<Data>): void
Parameters
- getIcon: NodeGetIconFunction<Data> = ...
Returns void
- Defined in tree/src/lib/tree.data-source.ts:390

setGetStyle

setGetStyle(getStyle?: NodeGetStyleFunction<any>): void
Parameters
- getStyle: NodeGetStyleFunction<any> = ...
Returns void
- Defined in tree/src/lib/tree.data-source.ts:601

setGetType

setGetType(getType?: NodeGetTypeFunction<any>): void
Parameters
- getType: NodeGetTypeFunction<any> = ...
Returns void
- Defined in tree/src/lib/tree.data-source.ts:605

setHasDetails

setHasDetails(hasDetails?: NodeHasDetailsFunction<Data>): void
Parameters
- hasDetails: NodeHasDetailsFunction<Data> = ...
Returns void
- Defined in tree/src/lib/tree.data-source.ts:394

setMatchFilter

setMatchFilter(matchFilter: (node: Node<Data>) => boolean): void
Parameters
- matchFilter: (node: Node<Data>) => boolean
Returns void
- Defined in tree/src/lib/tree.data-source.ts:380

setToDisplay

setToDisplay(toDisplay?: NodeToDisplayFunction<Data>): void
Parameters
- toDisplay: NodeToDisplayFunction<Data> = ...
Returns void
- Defined in tree/src/lib/tree.data-source.ts:384

setTreeControl

setTreeControl(treeControl: FlatTreeControl<Node<Data, any>>): void
Parameters
- treeControl: FlatTreeControl<Node<Data, any>>
Returns void
- Defined in tree/src/lib/tree.data-source.ts:376

toJSON

toJSON(): object
Returns object
Inherited from BaseDataSource.toJSON
- Defined in data-source/src/lib/base.data-source.ts:280

toNode

toNode(
    parent: null | Node<Data, any>,
    item: Data,
    depth?: number,
    onExpand?: ExpandNodeFunction<Data>,
    onCollapse?: ExpandNodeFunction<Data>,
    onSelect?: ExpandNodeFunction<Data>,
    onDeselect?: ExpandNodeFunction<Data>,
): Promise<Node<Data, any>>
Parameters
- parent: null | Node<Data, any>
- item: Data
- depth: number = 0
- onExpand: ExpandNodeFunction<Data> = ...
- onCollapse: ExpandNodeFunction<Data> = ...
- onSelect: ExpandNodeFunction<Data> = ...
- onDeselect: ExpandNodeFunction<Data> = ...
Returns Promise<Node<Data, any>>
- Defined in tree/src/lib/tree.data-source.ts:484

toPromise

toPromise(viewer: BaseDataSourceViewer): Promise<Node<Data, any>[]>
Creates a connection to tha data source and converts the Observable into a promise and then disconnects the viewer
Parameters
- viewer: BaseDataSourceViewer
Returns Promise<Node<Data, any>[]>
Inherited from BaseDataSource.toPromise
- Defined in data-source/src/lib/base.data-source.ts:264

updateNodes

updateNodes(): void
recall the getStyle, getIcon and toDisplay methods and update the node objects

Returns void
- Defined in tree/src/lib/tree.data-source.ts:613

`Static`add

add(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from BaseDataSource.add
- Defined in definition/src/lib/definition.ts:94

`Static`remove

remove(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from BaseDataSource.remove
- Defined in definition/src/lib/definition.ts:102

Class TreeDataSource<Data, RootParameters, NodeParameters>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TreeDataSource<Data, RootParameters, NodeParameters>

Properties

Internal__id

Protected_connectedViewer

Protected_connectedViewerTeardown

Protected Optional_data

Protected_data$

Protected_initialised

Protected_lastRefreshed

Protected_retry$

Protected_viewerIds

Readonlychange$

ReadonlychildrenRemoteMethod

Readonlydestroyed$

Readonlyerror$

expanded

getIcon

getStyle

getType

hasDetails

OptionalhasError

ReadonlyhasError$

Readonlyinitialised$

Readonlyinterceptors

Optionalloading

loading$

matchFilter

metadata

ReadonlyrootRemoteMethod

searchForm

selected

toDisplay

tree$

treeControl

Static Readonlydestroyed$

Static Readonlyinitialised$

Static Readonlyinstances

Accessors

data

Returns undefined | Data

hasConnections

Returns boolean

id

Returns string

lastRefreshed

Returns null | Date

nodeParameters

Returns null | NodeParameters

Parameters

Returns void

Methods

Protected_connect

Parameters

Returns Observable<Node<Data, any>[]>

Protected_disconnect

Parameters

Returns void

applyMetadata

Parameters

Returns void

attach

Parameters

Returns Observable<Node<Data, any>[]>

collapseNode

Parameters

Returns Promise<void>

connect

`Internal`__id

`Protected`_connectedViewer

`Protected`_connectedViewerTeardown

`Protected` `Optional`_data

`Protected`_data$

`Protected`_initialised

`Protected`_lastRefreshed

`Protected`_retry$

`Protected`_viewerIds

`Readonly`change$

`Readonly`childrenRemoteMethod

`Readonly`destroyed$

`Readonly`error$

`Optional`hasError

`Readonly`hasError$

`Readonly`initialised$

`Readonly`interceptors

`Optional`loading

`Readonly`rootRemoteMethod

`Static` `Readonly`destroyed$

`Static` `Readonly`initialised$

`Static` `Readonly`instances

`Protected`_connect

`Protected`_disconnect

`Protected`genericRetryFunction

`Protected`handelError