arlas-wui-toolkit / Exports / AnalyticsBoardComponent

Class: AnalyticsBoardComponent

This component organizes the Widgets in a board. A Widget is declared within a "group" in the configuration. A group contains one or more Widgets

Implements

• OnInit
• AfterViewInit
• OnChanges
• OnDestroy

Table of contents

Constructors

• constructor

Properties

• analyticsService
• boardOutputs
• collaborativeService
• collapsedHeaderHeight
• colorSpinner
• diameterSpinner
• expandedHeaderHeight
• groups
• mode
• modeChange
• showIndicators
• showSpinner
• spinnerOptions
• strokeWidthSpinner
• target

Methods

• changeMode
• closePanel
• drop
• listenOutput
• ngAfterViewInit
• ngOnChanges
• ngOnDestroy
• ngOnInit
• openPanel
• removeFilter
• scrollToAnalyticsComponent

Constructors

constructor

• new AnalyticsBoardComponent(collaborativeService, analyticsService)

Parameters

Name	Type
collaborativeService	ArlasCollaborativesearchService
analyticsService	AnalyticsService

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:95

Properties

analyticsService

• analyticsService: AnalyticsService

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:97

---

boardOutputs

• boardOutputs: EventEmitter<{ data?: any ; event: string ; origin: string }>

Output

: Angular

Description

Emits an event coming from one of the Widgets. The emitted output has information about the origin which is the contributor id of the Widget; event the name of the event; and eventually data which contains the emitted data from the component.

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:77

---

collaborativeService

• Protected collaborativeService: ArlasCollaborativesearchService

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:96

---

collapsedHeaderHeight

• collapsedHeaderHeight: number = 32

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:93

---

colorSpinner

• colorSpinner: string = 'primary'

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:60

---

diameterSpinner

• diameterSpinner: number = 100

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:61

---

expandedHeaderHeight

• expandedHeaderHeight: number = 48

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:92

---

groups

• groups: AnalyticGroupConfiguration[]

Description

List of groups. Each group contains one or more widgets.

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:90

---

mode

• mode: string = 'normal'

Input

: Angular

Description

Display mode of the analytics tab. Can be 'normal' or 'compact'.

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:46

---

modeChange

• modeChange: EventEmitter<string>

Output

: Angular

Description

Emits an event when the display mode of a group is changed. The value transmitted is the group id

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:83

---

showIndicators

• showIndicators: boolean = false

Input

: Angular

Description

Whether or not the indicators are displayed when a filter is active on a group or tab

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:68

---

showSpinner

• showSpinner: boolean = false

Input

: Angular

Description

Whether or not the spinner is displayed when a component is loading data

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:58

---

spinnerOptions

• spinnerOptions: SpinnerOptions

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:85

---

strokeWidthSpinner

• strokeWidthSpinner: number = 5

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:62

---

target

• target: string

Input

: Angular

Description

Id of the element to scroll to inside of the analytics board.

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:52

Methods

changeMode

▸ changeMode(event): void

Parameters

Name	Type
event	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:146

---

closePanel

▸ closePanel(group): void

Parameters

Name	Type
group	AnalyticGroupConfiguration

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:159

---

drop

▸ drop(event): void

Parameters

Name	Type
event	CdkDragDrop<string[], string[], any>

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:142

---

listenOutput

▸ listenOutput(event): void

Emits the widgets output events.

Parameters

Name	Type	Description
event	Object	Name of the event
event.data?	any	-
event.event	string	-
event.origin	string	-

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:138

---

ngAfterViewInit

▸ ngAfterViewInit(): void

Returns

void

Implementation of

AfterViewInit.ngAfterViewInit

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:121

---

ngOnChanges

▸ ngOnChanges(changes): void

Parameters

Name	Type
changes	SimpleChanges

Returns

void

Implementation of

OnChanges.ngOnChanges

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:115

---

ngOnDestroy

▸ ngOnDestroy(): void

Returns

void

Implementation of

OnDestroy.ngOnDestroy

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:163

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:100

---

openPanel

▸ openPanel(group): void

Parameters

Name	Type
group	AnalyticGroupConfiguration

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:155

---

removeFilter

▸ removeFilter(groupId, event): void

Parameters

Name	Type
groupId	string
event	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:150

---

scrollToAnalyticsComponent

▸ scrollToAnalyticsComponent(target): void

Parameters

Name	Type
target	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/analytics/analytics-board/analytics-board.component.ts:125