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

Table of contents

Constructors

• constructor

Properties

• activeFilterGroup
• activeFilterTab
• activeIndex
• boardOutputs
• colorSpinner
• diameterSpinner
• groups
• groupsByTab
• groupsDisplayStatusMap
• groupsTabsKey
• isActiveDragDrop
• mode
• modeChange
• showIndicators
• showSpinner
• spinnerOptions
• strokeWidthSpinner
• tabs
• target
• wasClosedMap

Methods

• activateGroupContribution
• addWidget
• animationDone
• cancelAllOtherTabsContribution
• cancelGroupContribution
• changeMode
• closePanel
• drop
• getContributorStatus
• listenOutput
• ngAfterViewInit
• ngOnChanges
• ngOnInit
• openPanel
• removeFilter
• removeTabFilter
• scrollToAnalyticsComponent
• setActiveFilterGroup
• setActiveFilterTab
• tabChange

Constructors

constructor

• new AnalyticsBoardComponent(collaborativeService, configService, activatedRoute, router)

Parameters

Name	Type
collaborativeService	ArlasCollaborativesearchService
configService	ArlasConfigService
activatedRoute	ActivatedRoute
router	Router

Defined in

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

Properties

activeFilterGroup

• activeFilterGroup: Map<string, boolean>

Defined in

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

---

activeFilterTab

• activeFilterTab: Map<string, boolean>

Defined in

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

---

activeIndex

• activeIndex: number = 0

Defined in

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

---

boardOutputs

• boardOutputs: Subject<{ 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-board/analytics-board.component.ts:80

---

colorSpinner

• colorSpinner: string = 'primary'

Defined in

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

---

diameterSpinner

• diameterSpinner: number = 100

Defined in

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

---

groups

• groups: AnalyticGroupConfiguration[]

input : Angular

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

Defined in

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

---

groupsByTab

• groupsByTab: { groups: AnalyticGroupConfiguration[] ; index: string }[]

Defined in

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

---

groupsDisplayStatusMap

• groupsDisplayStatusMap: Map<string, boolean>

description Map of that informs which groupIds to display/hide

Defined in

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

---

groupsTabsKey

• groupsTabsKey: string[]

Defined in

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

---

isActiveDragDrop

• isActiveDragDrop: boolean = false

Defined in

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

---

mode

• mode: string = 'normal'

Defined in

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

---

modeChange

• modeChange: Subject<string>

Defined in

projects/arlas-toolkit/src/lib/components/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-board/analytics-board.component.ts:70

---

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-board/analytics-board.component.ts:60

---

spinnerOptions

• spinnerOptions: SpinnerOptions

Defined in

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

---

strokeWidthSpinner

• strokeWidthSpinner: number = 5

Defined in

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

---

tabs

• tabs: Map<string, AnalyticsTabs[]>

Defined in

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

---

target

• target: string

Defined in

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

---

wasClosedMap

• wasClosedMap: Map<string, boolean>

Defined in

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

Methods

activateGroupContribution

▸ activateGroupContribution(group): void

Parameters

Name	Type
group	AnalyticGroupConfiguration

Returns

void

Defined in

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

---

addWidget

▸ addWidget(group, display): void

Parameters

Name	Type	Description
group	AnalyticGroupConfiguration	Group declared in configuration file
display	boolean	Whether to display the widget

Returns

void

Defined in

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

---

animationDone

▸ animationDone(): void

Returns

void

Defined in

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

---

cancelAllOtherTabsContribution

▸ cancelAllOtherTabsContribution(tabIndex): void

Parameters

Name	Type
tabIndex	number

Returns

void

Defined in

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

---

cancelGroupContribution

▸ cancelGroupContribution(group): void

Parameters

Name	Type
group	AnalyticGroupConfiguration

Returns

void

Defined in

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

---

changeMode

▸ changeMode(event): void

Parameters

Name	Type
event	any

Returns

void

Defined in

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

---

closePanel

▸ closePanel(group): void

Parameters

Name	Type
group	AnalyticGroupConfiguration

Returns

void

Defined in

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

---

drop

▸ drop(event, tabKey): void

Parameters

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

Returns

void

Defined in

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

---

getContributorStatus

▸ getContributorStatus(id): boolean

Parameters

Name	Type
id	any

Returns

boolean

Defined in

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

---

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-board/analytics-board.component.ts:243

---

ngAfterViewInit

▸ ngAfterViewInit(): void

Returns

void

Implementation of

AfterViewInit.ngAfterViewInit

Defined in

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

---

ngOnChanges

▸ ngOnChanges(changes): void

Parameters

Name	Type
changes	SimpleChanges

Returns

void

Implementation of

OnChanges.ngOnChanges

Defined in

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

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

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

---

openPanel

▸ openPanel(group): void

Parameters

Name	Type
group	AnalyticGroupConfiguration

Returns

void

Defined in

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

---

removeFilter

▸ removeFilter(groupId, event): void

Parameters

Name	Type
groupId	string
event	any

Returns

void

Defined in

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

---

removeTabFilter

▸ removeTabFilter(tabId, event): void

Parameters

Name	Type
tabId	string
event	any

Returns

void

Defined in

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

---

scrollToAnalyticsComponent

▸ scrollToAnalyticsComponent(target): void

Parameters

Name	Type
target	string

Returns

void

Defined in

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

---

setActiveFilterGroup

▸ setActiveFilterGroup(): void

Returns

void

Defined in

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

---

setActiveFilterTab

▸ setActiveFilterTab(): void

Returns

void

Defined in

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

---

tabChange

▸ tabChange(index): void

Parameters

Name	Type
index	number

Returns

void

Defined in

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