arlas-web-contributors > "contributors/TreeContributor" > TreeContributor

Class: TreeContributor

Hierarchy

Contributor

↳ TreeContributor

Index

Constructors

Properties

Methods


Constructors

constructor

new TreeContributor(identifier: string, collaborativeSearcheService: CollaborativesearchService, configService: ConfigService, title: string, collection: string): TreeContributor

Overrides Contributor.__constructor

Defined in contributors/TreeContributor.ts:69

Parameters:

Name Type
identifier string
collaborativeSearcheService CollaborativesearchService
configService ConfigService
title string
collection string

Returns: TreeContributor


Properties

<Protected> cacheDuration

● cacheDuration: number

Inherited from Contributor.cacheDuration

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:17


collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Inherited from Contributor.collaborativeSearcheService

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:9


collection

● collection: string

Inherited from Contributor.collection

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:14


collections

● collections: CollectionAggField[]

Inherited from Contributor.collections

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:15


colorField

● colorField: any = this.getConfigValue('colorField')

Defined in contributors/TreeContributor.ts:53


configService

● configService: ConfigService

Inherited from Contributor.configService

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:8


endCollaborationEvent

● endCollaborationEvent: Subject<unknown>

Inherited from Contributor.endCollaborationEvent

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:16


identifier

● identifier: string

Inherited from Contributor.identifier

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:7


isDataUpdating

● isDataUpdating: boolean

Inherited from Contributor.isDataUpdating

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:13


nodeSizeMinPourcentage

● nodeSizeMinPourcentage: any = (this.getConfigValue('nodeSizeMinPourcentage')) ? this.getConfigValue('nodeSizeMinPourcentage') : 0.01

Defined in contributors/TreeContributor.ts:47


selectedNodesPathsList

● selectedNodesPathsList: Array<Array<SimpleNode>> = new Array>()

Defined in contributors/TreeContributor.ts:57


title

● title: string

Defined in contributors/TreeContributor.ts:39


treeData

● treeData: TreeNode

Defined in contributors/TreeContributor.ts:43


updateData

● updateData: boolean

Inherited from Contributor.updateData

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:46


Methods

computeData

computeData(aggregationResponse: AggregationResponse): TreeNode

Overrides Contributor.computeData

Defined in contributors/TreeContributor.ts:145

Parameters:

Name Type
aggregationResponse AggregationResponse

Returns: TreeNode


fetchData

fetchData(collaborationEvent: CollaborationEvent): Observable<AggregationResponse>

Overrides Contributor.fetchData

Defined in contributors/TreeContributor.ts:113

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: Observable<AggregationResponse>


getAggregations

getAggregations(): Aggregation[]

Defined in contributors/TreeContributor.ts:94

Returns: Aggregation[]


getConfigValue

getConfigValue(key: string): any

Inherited from Contributor.getConfigValue

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:31

Parameters:

Name Type Description
key string a `key` defined in configuration.

Returns: any value of the key in configuration.


getFilterDisplayName

getFilterDisplayName(): string

Overrides Contributor.getFilterDisplayName

Defined in contributors/TreeContributor.ts:109

Returns: string


getName

getName(): string

Inherited from Contributor.getName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:35

Returns: string name of contributor set in configuration.


getPackageName

getPackageName(): string

Overrides Contributor.getPackageName

Defined in contributors/TreeContributor.ts:105

Returns: string Package name for the configuration service.


selectedNodesListChanged

selectedNodesListChanged(selectedNodesPathsList: Array<Array<SimpleNode>>): void

Defined in contributors/TreeContributor.ts:231

Parameters:

Name Type
selectedNodesPathsList Array<Array<SimpleNode>>

Returns: void


setAggregations

setAggregations(aggregations: Array<Aggregation>): void

Defined in contributors/TreeContributor.ts:98

Parameters:

Name Type
aggregations Array<Aggregation>

Returns: void


setData

setData(data: TreeNode): TreeNode

Overrides Contributor.setData

Defined in contributors/TreeContributor.ts:166

Parameters:

Name Type
data TreeNode

Returns: TreeNode


setName

setName(name: string): void

Inherited from Contributor.setName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:39

Parameters:

Name Type
name string

Returns: void set the name of the contributor


setSelection

setSelection(data: TreeNode, collaboration: Collaboration): any

Overrides Contributor.setSelection

Defined in contributors/TreeContributor.ts:171

Parameters:

Name Type
data TreeNode
collaboration Collaboration

Returns: any


updateFromCollaboration

updateFromCollaboration(collaborationEvent: CollaborationEvent): void

Inherited from Contributor.updateFromCollaboration

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:55

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: void


updateTreeDataSearch

updateTreeDataSearch(search: any): void

Defined in contributors/TreeContributor.ts:273

Parameters:

Name Type Description
search any the term used to filter tree data

Returns: void


<Static> getJsonSchema

getJsonSchema(): Object

Defined in contributors/TreeContributor.ts:90

Returns: Object Json schema for configuration.