arlas-web-contributors / MetricsTableContributor

Class: MetricsTableContributor

This contributor fetches metrics from different collection by term. The terms are value of a termfield specified for each collection. The fetched metrics are formatted into a table to provide data to MetricsTableComponent. This contributor handles multi-collection filters.

Extends

Contributor

Constructors

new MetricsTableContributor()

new MetricsTableContributor(identifier, collaborativeSearcheService, configService): MetricsTableContributor

Parameters

identifier

string

collaborativeSearcheService

CollaborativesearchService

configService

ConfigService

Returns

MetricsTableContributor

Overrides

Contributor.constructor

Defined in

src/contributors/MetricsTableContributor.ts:83

Properties

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

configService

configService: ConfigService

Inherited from

Contributor.configService

Defined in

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

configuration

configuration: MetricsVectorConfig[]

Configuration of the table. It includes what the term fields are for each collection and which metrics to display.

Defined in

src/contributors/MetricsTableContributor.ts:58

data

data: MetricsTable

The data that will be given as an input of the MetricsTable component.

Defined in

src/contributors/MetricsTableContributor.ts:75

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

maxValue

maxValue: number = -Number.MAX_VALUE

Defined in

src/contributors/MetricsTableContributor.ts:72

nbTerms

nbTerms: number

Number of terms fetched for each collection. The resulted table might have terms between numberOfBuckets and nbCollection * numberOfBuckets.

Defined in

src/contributors/MetricsTableContributor.ts:53

operatorChanged$

operatorChanged$: Observable\<OpEnum>

Defined in

src/contributors/MetricsTableContributor.ts:70

selectedTerms

selectedTerms: string[] = []

List of currently selected terms (rows) of the table.

Defined in

src/contributors/MetricsTableContributor.ts:77

sort

sort: MetricsTableSortConfig

Configuration of the sort to apply to the metrics table.

Defined in

src/contributors/MetricsTableContributor.ts:62

table

table: MetricsVectors

An object that simplifies building arlas-api aggregation requests from the table configuration.

Defined in

src/contributors/MetricsTableContributor.ts:48

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(data): ComputableResponse

Parameters

data

ComputableResponse

Returns

ComputableResponse

Overrides

Contributor.computeData

Defined in

src/contributors/MetricsTableContributor.ts:187

fetchData()

fetchData(collaborationEvent): Observable\<ComputableResponse>

Parameters

collaborationEvent

CollaborationEvent

Returns

Observable\<ComputableResponse>

Overrides

Contributor.fetchData

Defined in

src/contributors/MetricsTableContributor.ts:100

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

Overrides

Contributor.getFilterDisplayName

Defined in

src/contributors/MetricsTableContributor.ts:414

getFilterOperator()

getFilterOperator(): OpEnum

Returns

OpEnum

Defined in

src/contributors/MetricsTableContributor.ts:191

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/MetricsTableContributor.ts:409

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/MetricsTableContributor.ts:419

onRowSelect()

onRowSelect(terms): void

Parameters

terms

Set\<string>

Returns

void

Defined in

src/contributors/MetricsTableContributor.ts:202

setData()

setData(data): any

Parameters

data

ComputableResponse

Returns

any

Overrides

Contributor.setData

Defined in

src/contributors/MetricsTableContributor.ts:232

setFilterOperator()

setFilterOperator(operator, emit): void

Parameters

operator

OpEnum

emit

boolean = false

Returns

void

Defined in

src/contributors/MetricsTableContributor.ts:195

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(cr, collaboration): Observable\<any>

Parameters

cr

ComputableResponse

collaboration

Collaboration

Returns

Observable\<any>

Overrides

Contributor.setSelection

Defined in

src/contributors/MetricsTableContributor.ts:327

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

getJsonSchema()

static getJsonSchema(): Object

Returns

Object

Defined in

src/contributors/MetricsTableContributor.ts:424