arlas-wui-toolkit / Exports / AnalyticsService

Class: AnalyticsService

Table of contents

Constructors

• constructor

Properties

• isActiveDragDrop
• tabChange

Accessors

• activeFilterGroup
• activeFilterTab
• activeTab
• groups
• groupsDisplayStatusMap
• tabs

Methods

• activateGroupContribution
• addWidget
• cancelAllOtherTabsContribution
• cancelAllTabsContribution
• cancelGroupContribution
• closePanel
• dropGroup
• getActiveGroups
• initializeGroups
• openPanel
• removeFilter
• removeTabFilter
• selectTab
• setActiveFilterGroup
• setActiveFilterTab
• setGroupsDisplayStatusMap

Constructors

constructor

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

Parameters

Name	Type
configService	ArlasConfigService
collaborativeService	ArlasCollaborativesearchService
activatedRoute	ActivatedRoute
router	Router

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:100

Properties

isActiveDragDrop

• isActiveDragDrop: boolean

Description

Whether drag and drop is active for the groups inside of the analytics board

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:43

---

tabChange

• tabChange: EventEmitter<string>

Description

Emits the name of the tab when the selected tab in the menu has changed

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:38

Accessors

activeFilterGroup

• get activeFilterGroup(): Map<string, boolean>

Description

Map of which groups are currently filtered on

Returns

Map<string, boolean>

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:497

---

activeFilterTab

• get activeFilterTab(): Map<string, boolean>

Description

Map of which tabs are currently filtered on

Returns

Map<string, boolean>

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:490

---

activeTab

• get activeTab(): number

Description

Index of the currently selected tab. Can be undefined when no tab is selected.

Returns

number

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:504

---

groups

• get groups(): AnalyticGroupConfiguration[]

Description

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

Returns

AnalyticGroupConfiguration[]

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:379

---

groupsDisplayStatusMap

• get groupsDisplayStatusMap(): Map<string, boolean>

Description

Map of whether to display each group

Returns

Map<string, boolean>

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:483

---

tabs

• get tabs(): AnalyticsTabs[]

Description

List of tabs. Each tab contains one or more groups.

Returns

AnalyticsTabs[]

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:476

Methods

activateGroupContribution

▸ activateGroupContribution(group): void

Activates all the contributors of the group.

Parameters

Name	Type	Description
group	AnalyticGroupConfiguration	Configuration of the group to activate

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:238

---

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/services/analytics/analytics.service.ts:262

---

cancelAllOtherTabsContribution

▸ cancelAllOtherTabsContribution(tabIndex): void

Parameters

Name	Type
tabIndex	number

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:189

---

cancelAllTabsContribution

▸ cancelAllTabsContribution(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:199

---

cancelGroupContribution

▸ cancelGroupContribution(group): void

Deactivates all the contributors of the group that are not present in the active tab.

Parameters

Name	Type	Description
group	AnalyticGroupConfiguration	Configuration of the group to deactivate

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:213

---

closePanel

▸ closePanel(group): void

Deactivates the data upating of the contributors of every widget of the group.

Parameters

Name	Type	Description
group	AnalyticGroupConfiguration	Configuration of the group to hide

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:178

---

dropGroup

▸ dropGroup(event): void

Updates the order of the groups of the current tab. Stores in the local storage this new order.

Parameters

Name	Type	Description
event	CdkDragDrop<string[], string[], any>	Drop event of a group being moved

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:328

---

getActiveGroups

▸ getActiveGroups(): AnalyticGroupConfiguration[]

Returns

AnalyticGroupConfiguration[]

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:112

---

initializeGroups

▸ initializeGroups(groups): void

Parameters

Name	Type
groups	AnalyticGroupConfiguration[]

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:383

---

openPanel

▸ openPanel(group): void

Activates the data upating of the contributors of every widget of the group.

Parameters

Name	Type	Description
group	AnalyticGroupConfiguration	Configuration of the group to display

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:161

---

removeFilter

▸ removeFilter(groupId): void

Removes all the filters of the given group

Parameters

Name	Type	Description
groupId	string	Group id

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:273

---

removeTabFilter

▸ removeTabFilter(tabId): void

Removes all the filters of the given tab

Parameters

Name	Type	Description
tabId	string	Tab id

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:285

---

selectTab

▸ selectTab(tabIndex): void

Triggered when a tab is selected by the menu. Updates the URL to store which tab the user is currently on. Deactivates data updating of the widgets of the hidden tabs. Emits a tab change event.

Parameters

Name	Type	Description
tabIndex	number	Index of the tab selected. Can be undefined if none is selected.

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:123

---

setActiveFilterGroup

▸ setActiveFilterGroup(): void

Updates the map of which groups are currently filtered on

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:294

---

setActiveFilterTab

▸ setActiveFilterTab(): void

Updates the map of which tabs are currently filtered on

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:310

---

setGroupsDisplayStatusMap

▸ setGroupsDisplayStatusMap(statusMap): void

Parameters

Name	Type
statusMap	Map<string, boolean>

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/analytics/analytics.service.ts:108