arlas-wui-toolkit / Exports / TimelineComponent

Class: TimelineComponent

This component contains - A main timeline histogram that plots the count (or other metric) of data over time - A detailed timeline histogram that plots the current selection on the main timeline (optional) - A datepicker (optional) - Shortcut labels that allow to apply predefined temporal filters (Last year, Last month, Today, etc ...)

Implements

• OnInit
• OnDestroy

Table of contents

Constructors

• constructor

Properties

• activeDatePicker
• arlasCollaborativesearchService
• colorSpinner
• detailedTimelineComponent
• detailedTimelineContributor
• detailedTimelineData
• detailedTimelineHistogramComponent
• detailedTimelineIntervalSelection
• diameterSpinner
• isDisplayHistogram
• isDisplayHistogramChange
• mainCollection
• showDetailedTimeline
• showSpinner
• strokeWidthSpinner
• timelineComponent
• timelineContributor
• timelineData
• timelineHistogramComponent
• timelineLegend
• timelineOverlayRef

Methods

• afterDetailedDataPlotted
• emitTooltip
• hideHistogramTooltip
• hideShowCollection
• ngOnDestroy
• ngOnInit
• onDetailedIntervalBrushed
• onRemoveCollaboration
• onTimelineIntervalBrushed
• showHistogramTooltip
• toggleTimeline

Constructors

constructor

• new TimelineComponent(arlasCollaborativesearchService, arlasStartupService, arlasOverlayService, arlasColorService, collectionService)

Parameters

Name	Type
arlasCollaborativesearchService	ArlasCollaborativesearchService
arlasStartupService	ArlasStartupService
arlasOverlayService	ArlasOverlayService
arlasColorService	ArlasColorService
collectionService	ArlasCollectionService

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:124

Properties

activeDatePicker

• activeDatePicker: boolean = false

Input

: Angular

Description

Whether the date picker is enabled

Defined in

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

---

arlasCollaborativesearchService

• Protected arlasCollaborativesearchService: ArlasCollaborativesearchService

Defined in

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

---

colorSpinner

• colorSpinner: string = 'primary'

Input

: Angular

Description

Color palette of the spinner when loading data

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:86

---

detailedTimelineComponent

• detailedTimelineComponent: TimelineConfiguration

Input

: Angular

Description

Optional input. If not set, the detailed timeline is deactivated. Same as the precedent input, In this object, all the necessary inputs of HistogramComponent (ARLAS-web-components) must be set as well as the identifier of the detailed contributor that fetches data within the current selection. The DetailedHistogramContributor should be declared before in the contributorRegistry of ArlasStartupService

Defined in

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

---

detailedTimelineContributor

• detailedTimelineContributor: DetailedHistogramContributor

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:110

---

detailedTimelineData

• detailedTimelineData: any[] = []

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:114

---

detailedTimelineHistogramComponent

• detailedTimelineHistogramComponent: HistogramComponent

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:107

---

detailedTimelineIntervalSelection

• detailedTimelineIntervalSelection: SelectedOutputValues

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:112

---

diameterSpinner

• diameterSpinner: number = 100

Input

: Angular

Description

Diameter of the spinner when loading data

Defined in

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

---

isDisplayHistogram

• isDisplayHistogram: boolean = true

Input

: Angular

Description

Whether to display the timelines' histogram

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:74

---

isDisplayHistogramChange

• isDisplayHistogramChange: EventEmitter<boolean>

Output

: Angular

Description

Emits when the value of isDisplayHistogram changes

Defined in

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

---

mainCollection

• mainCollection: string

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:120

---

showDetailedTimeline

• showDetailedTimeline: boolean = false

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:109

---

showSpinner

• showSpinner: boolean = false

Input

: Angular

Description

Whether or not the spinner is displayed when loading data

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:80

---

strokeWidthSpinner

• strokeWidthSpinner: number = 5

Input

: Angular

Description

Stroke of the spinner when loading data

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:98

---

timelineComponent

• timelineComponent: TimelineConfiguration

Input

: Angular

Description

In this object, all the necessary inputs of HistogramComponent (ARLAS-web-components) must be set as well as the identifier of the contributor that fetches timeline data. The HistogramContributor should be declared before in the contributorRegistry of ArlasStartupService

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:55

---

timelineContributor

• timelineContributor: HistogramContributor

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:111

---

timelineData

• timelineData: any[] = []

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:113

---

timelineHistogramComponent

• timelineHistogramComponent: HistogramComponent

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:106

---

timelineLegend

• timelineLegend: CollectionLegend[] = []

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:119

---

timelineOverlayRef

• timelineOverlayRef: ArlasOverlayRef

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:118

Methods

afterDetailedDataPlotted

▸ afterDetailedDataPlotted(e): void

Runs when the detailed timeline is plotted. Sets current selection of detailed timeline after it is plotted Applies the current selection of detailed timeline on the main timeline

Parameters

Name	Type
e	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:220

---

emitTooltip

▸ emitTooltip(tooltip, e): void

Parameters

Name	Type
tooltip	HistogramTooltip
e	ElementRef<any>

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:258

---

hideHistogramTooltip

▸ hideHistogramTooltip(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:252

---

hideShowCollection

▸ hideShowCollection(collectionLegend): void

Parameters

Name	Type
collectionLegend	CollectionLegend

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:269

---

ngOnDestroy

▸ ngOnDestroy(): void

Returns

void

Implementation of

OnDestroy.ngOnDestroy

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:187

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:132

---

onDetailedIntervalBrushed

▸ onDetailedIntervalBrushed(selections): void

Recalculates the new data of detailed timeline and resets its own current selection.

Parameters

Name	Type	Description
selections	SelectedOutputValues[]	List containing only the current selection of detailed timeline

Returns

void

Defined in

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

---

onRemoveCollaboration

▸ Protected onRemoveCollaboration(): void

On the event sent by the timeline-tools, remove the timeline collaboration and hide the detailed timeline

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:330

---

onTimelineIntervalBrushed

▸ onTimelineIntervalBrushed(selections): void

Runs when the selection is brushed on main timeline.

Parameters

Name	Type	Description
selections	SelectedOutputValues[]	List containing only the current selection of detailed timeline

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:207

---

showHistogramTooltip

▸ showHistogramTooltip(tooltip, e, xOffset, yOffset, right): void

Parameters

Name	Type
tooltip	HistogramTooltip
e	ElementRef<any>
xOffset	number
yOffset	number
right	boolean

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:243

---

toggleTimeline

▸ toggleTimeline(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:336