Skip to content

arlas-web-contributors > "contributors/PowerbarsContributor" > PowerbarsContributor

Class: PowerbarsContributor

This contributor works with the Angular PowerbarsComponent of the Arlas-web-components project. This class make the brigde between the component which displays the data and the collaborativeSearchService of the Arlas-web-core which retrieve the data from the server. deprecated:

Hierarchy

TreeContributor

↳ PowerbarsContributor

Index

Constructors

Properties

Methods


Constructors

constructor

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

Overrides TreeContributor.constructor

Defined in contributors/PowerbarsContributor.ts:55

Build a new contributor.

Parameters:

Name Type Description
identifier string Identifier of the contributor.
collaborativeSearcheService CollaborativesearchService Instance of CollaborativesearchService from Arlas-web-core.
configService ConfigService Instance of ConfigService from Arlas-web-core.
title string

Returns: PowerbarsContributor


Properties

collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Inherited from Contributor.collaborativeSearcheService

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


configService

● configService: ConfigService

Inherited from Contributor.configService

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


identifier

● identifier: string

Inherited from Contributor.identifier

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


nodeSizeMinPourcentage

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

Inherited from TreeContributor.nodeSizeMinPourcentage

Defined in contributors/TreeContributor.ts:45

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


powerbarsData

● powerbarsData: TreeNode

Defined in contributors/PowerbarsContributor.ts:45

data retrieved from Server response and to be returned for the component as input input(): inputData


powerbarsTitle

● powerbarsTitle: string

Defined in contributors/PowerbarsContributor.ts:55

Title given to the aggregation result


selectedBars

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

Defined in contributors/PowerbarsContributor.ts:50

List of selected nodes to be returned to a powerbars component to determine the powerbars to select


selectedNodesPathsList

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

Inherited from TreeContributor.selectedNodesPathsList

Defined in contributors/TreeContributor.ts:50

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


title

● title: string

Inherited from TreeContributor.title

Defined in contributors/TreeContributor.ts:37

Title given to the aggregation result


treeData

● treeData: TreeNode

Inherited from TreeContributor.treeData

Defined in contributors/TreeContributor.ts:41

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


Methods

computeData

computeData(aggregationResponse: AggregationResponse): TreeNode

Overrides TreeContributor.computeData

Defined in contributors/PowerbarsContributor.ts:96

Parameters:

Name Type
aggregationResponse AggregationResponse

Returns: TreeNode


fetchData

fetchData(collaborationEvent: CollaborationEvent): Observable<AggregationResponse>

Overrides TreeContributor.fetchData

Defined in contributors/PowerbarsContributor.ts:92

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: Observable<AggregationResponse>


getConfigValue

getConfigValue(key: string): any

Inherited from Contributor.getConfigValue

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

Parameters:

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

Returns: any value of the key in configuration.


getFilterDisplayName

getFilterDisplayName(): string

Overrides TreeContributor.getFilterDisplayName

Defined in contributors/PowerbarsContributor.ts:82

Returns: string Pretty name of contribution based on selected bar


getName

getName(): string

Inherited from Contributor.getName

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

Returns: string name of contributor set in configuration.


getPackageName

getPackageName(): string

Overrides TreeContributor.getPackageName

Defined in contributors/PowerbarsContributor.ts:88

Returns: string Package name for the configuration service.


selectedBarsChanged

selectedBarsChanged(selectedBars: Array<Array<SimpleNode>>): void

Defined in contributors/PowerbarsContributor.ts:111

Parameters:

Name Type
selectedBars Array<Array<SimpleNode>>

Returns: void


selectedNodesListChanged

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

Inherited from TreeContributor.selectedNodesListChanged

Defined in contributors/TreeContributor.ts:195

Parameters:

Name Type
selectedNodesPathsList Array<Array<SimpleNode>>

Returns: void


setData

setData(data: TreeNode): TreeNode

Overrides TreeContributor.setData

Defined in contributors/PowerbarsContributor.ts:100

Parameters:

Name Type
data TreeNode

Returns: TreeNode


setSelection

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

Overrides TreeContributor.setSelection

Defined in contributors/PowerbarsContributor.ts:105

Parameters:

Name Type
data TreeNode
collaboration Collaboration

Returns: any


updatePowerbarsData

updatePowerbarsData(search: any): void

Defined in contributors/PowerbarsContributor.ts:116

Parameters:

Name Type
search any

Returns: void


updateTreeDataSearch

updateTreeDataSearch(search: any): void

Inherited from TreeContributor.updateTreeDataSearch

Defined in contributors/TreeContributor.ts:235

description: apply the search term to filter the tree data

Parameters:

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

Returns: void


<Static> getJsonSchema

getJsonSchema(): Object

Overrides TreeContributor.getJsonSchema

Defined in contributors/PowerbarsContributor.ts:75

Returns: Object