Skip to content

arlas-web-contributors

arlas-web-contributors / TreeContributor

Class: TreeContributor

This contributor fetches data from multiple term aggregations and format the data as a tree. it can be used to fetch data for Donuts and powerbars

Extends

  • Contributor

Constructors

new TreeContributor()

new TreeContributor(identifier, collaborativeSearcheService, configService, title, collection): TreeContributor

Parameters

identifier

string

collaborativeSearcheService

CollaborativesearchService

configService

ConfigService

title

string

collection

string

Returns

TreeContributor

Overrides

Contributor.constructor

Defined in

src/contributors/TreeContributor.ts:82

Properties

allowOperatorChange

allowOperatorChange: any

Defined in

src/contributors/TreeContributor.ts:75

cacheDuration

protected cacheDuration: number

Inherited from

Contributor.cacheDuration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:18

collaborativeSearcheService

collaborativeSearcheService: CollaborativesearchService

Inherited from

Contributor.collaborativeSearcheService

Defined in

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

collection

collection: string

Inherited from

Contributor.collection

Defined in

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

collections

collections: CollectionAggField[]

Inherited from

Contributor.collections

Defined in

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

colorField

colorField: any

The field to retrieve the color of the node (optional), this field must be present in the include property of the fetch_hits for all the aggregations

Defined in

src/contributors/TreeContributor.ts:53

configService

configService: ConfigService

Inherited from

Contributor.configService

Defined in

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

emitMissingLeaf

emitMissingLeaf: Subject\<any[]>

Defined in

src/contributors/TreeContributor.ts:79

endCollaborationEvent

endCollaborationEvent: Subject\<CollaborationEvent>

Inherited from

Contributor.endCollaborationEvent

Defined in

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

identifier

identifier: string

Inherited from

Contributor.identifier

Defined in

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

isDataUpdating

isDataUpdating: boolean

Inherited from

Contributor.isDataUpdating

Defined in

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

linkedContributorId

linkedContributorId: string

Inherited from

Contributor.linkedContributorId

Defined in

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

nodeSizeMinPourcentage

nodeSizeMinPourcentage: any

The minimum ratio of the node in its level needed to be plotted. Otherwise the node is considered as OTHER

Defined in

src/contributors/TreeContributor.ts:47

operatorChangedEvent

operatorChangedEvent: Subject\<OpEnum>

Defined in

src/contributors/TreeContributor.ts:77

selectedNodesPathsList

selectedNodesPathsList: SimpleNode[][]

List of selected nodes to be returned to a component that accepts tree data as an input

Defined in

src/contributors/TreeContributor.ts:57

title

title: string

Title given to the aggregation result

Defined in

src/contributors/TreeContributor.ts:39

treeData

treeData: TreeNode

Data retrieved from ARLAS-server response and to be returned for the donut/powerbars component as an input

Defined in

src/contributors/TreeContributor.ts:43

Accessors

updateData

Get Signature

get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Set Signature

set updateData(value): void

Parameters
value

boolean

set if the data of contributor should be updated or not.

Returns

void

Inherited from

Contributor.updateData

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:49

Methods

computeData()

computeData(aggregationResponse): TreeNode

Parameters

aggregationResponse

AggregationResponse

Returns

TreeNode

Overrides

Contributor.computeData

Defined in

src/contributors/TreeContributor.ts:171

fetchData()

fetchData(collaborationEvent): Observable\<AggregationResponse>

Parameters

collaborationEvent

CollaborationEvent

Returns

Observable\<AggregationResponse>

Overrides

Contributor.fetchData

Defined in

src/contributors/TreeContributor.ts:138

getAggregations()

getAggregations(): Aggregation[]

Returns

Aggregation[]

Defined in

src/contributors/TreeContributor.ts:108

getConfigValue()

getConfigValue(key): any

Parameters

key

string

a key defined in configuration.

Returns

any

value of the key in configuration.

Inherited from

Contributor.getConfigValue

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:34

getFilterDisplayName()

getFilterDisplayName(): string

Returns

string

name and live informations about filter contributor.

Overrides

Contributor.getFilterDisplayName

Defined in

src/contributors/TreeContributor.ts:134

getFilterOperator()

getFilterOperator(): OpEnum

Returns

OpEnum

Defined in

src/contributors/TreeContributor.ts:116

getName()

getName(): string

Returns

string

name of contributor set in configuration.

Inherited from

Contributor.getName

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:41

getPackageName()

getPackageName(): string

Returns

string

Package name for the configuration service.

Overrides

Contributor.getPackageName

Defined in

src/contributors/TreeContributor.ts:130

isMyLinkedContributorCollaboration()

isMyLinkedContributorCollaboration(collaborationEvent): boolean

Parameters

collaborationEvent

CollaborationEvent

Returns

boolean

Inherited from

Contributor.isMyLinkedContributorCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:37

isMyOwnCollaboration()

isMyOwnCollaboration(collaborationEvent): boolean

Parameters

collaborationEvent

CollaborationEvent

Returns

boolean

Inherited from

Contributor.isMyOwnCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:36

isUpdateEnabledOnOwnCollaboration()

isUpdateEnabledOnOwnCollaboration(): boolean

Returns

boolean

Overrides

Contributor.isUpdateEnabledOnOwnCollaboration

Defined in

src/contributors/TreeContributor.ts:104

selectedNodesListChanged()

selectedNodesListChanged(selectedNodesPathsList): void

Parameters

selectedNodesPathsList

SimpleNode[][]

Returns

void

Defined in

src/contributors/TreeContributor.ts:311

setAggregations()

setAggregations(aggregations): void

Parameters

aggregations

Aggregation[]

Returns

void

Defined in

src/contributors/TreeContributor.ts:112

setData()

setData(data): TreeNode

Parameters

data

TreeNode

Returns

TreeNode

Overrides

Contributor.setData

Defined in

src/contributors/TreeContributor.ts:192

setFilterOperator()

setFilterOperator(operator, emit): void

Parameters

operator

OpEnum

emit

boolean = false

Returns

void

Defined in

src/contributors/TreeContributor.ts:120

setName()

setName(name): void

Parameters

name

string

Returns

void

set the name of the contributor

Inherited from

Contributor.setName

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:45

setSelection()

setSelection(data, collaboration): any

Parameters

data

TreeNode

collaboration

Collaboration

Returns

any

Overrides

Contributor.setSelection

Defined in

src/contributors/TreeContributor.ts:197

updateFromCollaboration()

updateFromCollaboration(collaborationEvent): void

Parameters

collaborationEvent

CollaborationEvent

Returns

void

Inherited from

Contributor.updateFromCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:62

updateTreeDataSearch()

updateTreeDataSearch(search): void

Parameters

any

the term used to filter tree data

Returns

void

Description

apply the search term to filter the tree data

Defined in

src/contributors/TreeContributor.ts:353

getJsonSchema()

static getJsonSchema(): Object

Returns

Object

Json schema for configuration.

Defined in

src/contributors/TreeContributor.ts:100