arlas-web-components / Exports / MetricsTableComponent

Class: MetricsTableComponent

Implements

• OnInit
• OnChanges

Table of contents

Constructors

• constructor

Properties

• applyColorTo
• colorsSaturationWeight
• filterOperator
• filterOperatorEvent
• header
• headerDisplayMode
• keysToColors
• metricsTable
• normaliseBy
• onSelect
• pendingMode
• powerBarsMap
• selectWithCheckbox
• selectedKeys
• selectedRows
• selectedTerms
• showRowField
• titleAreDifferent
• uniqueTitles
• useColorService

Methods

• addTermToSelectedList
• buildHeaders
• buildPowerBars
• clearAll
• ngOnChanges
• ngOnInit
• originalOrder
• setOperator
• togglePendingMode
• trackByFn
• updateSelectedRow
• updateSelectedTerm
• updateSelection
• getJsonSchema

Constructors

constructor

• new MetricsTableComponent(colorService, cdr)

Parameters

Name	Type
colorService	ArlasColorService
cdr	ChangeDetectorRef

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:136

Properties

applyColorTo

• applyColorTo: "column" | "row" = 'column'

Input

: Angular

Description

Choose how to apply colors to the table. By column : all the bars in same column will have the same color. By row : all the bars in the same row, will have the same color.

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:95

---

colorsSaturationWeight

• colorsSaturationWeight: any

Input

: Angular

Description

Knowing that saturation scale is [0, 1], colorsSaturationWeight is a factor (between 0 and 1) that tightens this scale to [(1-colorsSaturationWeight), 1]. Therefore saturation of generated colors will be within this tightened scale.

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:103

---

filterOperator

• filterOperator: FilterOperator

Input

: Angular

Description

Options about how to apply filters on metrics table - value : The default value. if 'Eq', the selected line is included in the ARLAS filter. if 'Neq', the selected line is excluded in the ARLAS filter. - display: Whether to display a switcher between 'Eq' and 'Neq' or keep the default operator all the time

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:61

---

filterOperatorEvent

• filterOperatorEvent: EventEmitter<"Neq" | "Eq">

Output

: Angular

Description

Emits the filter operator

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:69

---

header

• Protected header: ElementRef<any>

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:123

---

headerDisplayMode

• headerDisplayMode: "chip" | "title" | "full" = 'chip'

Description

Allow to select display mode for headers.

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:113

---

keysToColors

• keysToColors: [string, string][]

Input

: Angular

Description

List of [key, color] couples that associates a hex color to each key

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:81

---

metricsTable

• metricsTable: MetricsTable

Input

: Angular

Description

Data to build the table.

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:51

---

normaliseBy

• normaliseBy: "column" | "table" = 'table'

Description

Normalise bars progression based on the maximum value of each column OR of the whole table

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:118

---

onSelect

• onSelect: EventEmitter<Set<string>>

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:121

---

pendingMode

• Protected pendingMode: boolean = false

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:131

---

powerBarsMap

• Protected powerBarsMap: Map<string, PowerBar[]>

Map of

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:128

---

selectWithCheckbox

• selectWithCheckbox: boolean = true

Description

Allow to select a row by a checkbox

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:108

---

selectedKeys

• Protected selectedKeys: Set<string>

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:129

---

selectedRows

• Protected selectedRows: Map<string, MetricsTableRow>

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:130

---

selectedTerms

• selectedTerms: string[]

Input

: Angular

Description

selected terms list.

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:75

---

showRowField

• showRowField: boolean = true

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:119

---

titleAreDifferent

• Protected titleAreDifferent: boolean = true

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:132

---

uniqueTitles

• Protected uniqueTitles: MetricsTableHeader[]

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:133

---

useColorService

• useColorService: boolean = false

Input

: Angular

Description

Whether to allow colorizing the bar according to its term or not using keysToColors

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:88

Methods

addTermToSelectedList

▸ addTermToSelectedList(key): void

Parameters

Name	Type
key	string

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:242

---

buildHeaders

▸ buildHeaders(): void

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:167

---

buildPowerBars

▸ buildPowerBars(): void

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:197

---

clearAll

▸ clearAll(): void

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:238

---

ngOnChanges

▸ ngOnChanges(changes): void

Parameters

Name	Type
changes	SimpleChanges

Returns

void

Implementation of

OnChanges.ngOnChanges

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:156

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:148

---

originalOrder

▸ originalOrder(a, b): number

Parameters

Name	Type
a	KeyValue<string, MetricsTableRow>
b	KeyValue<string, MetricsTableRow>

Returns

number

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:282

---

setOperator

▸ setOperator(op): void

Parameters

Name	Type
op	"Neq" | "Eq"

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:298

---

togglePendingMode

▸ togglePendingMode(): void

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:273

---

trackByFn

▸ trackByFn(index, item): any

Parameters

Name	Type
index	any
item	any

Returns

any

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:277

---

updateSelectedRow

▸ updateSelectedRow(key): void

Parameters

Name	Type
key	string

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:258

---

updateSelectedTerm

▸ updateSelectedTerm(key): void

Parameters

Name	Type
key	string

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:248

---

updateSelection

▸ updateSelection(keys): void

Parameters

Name	Type
keys	string[]

Returns

void

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:231

---

getJsonSchema

▸ Static getJsonSchema(): Object

Returns

Object

Defined in

projects/arlas-components/src/lib/components/metrics-table/metrics-table.component.ts:294