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

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new TimelineComponent(arlasCollaborativesearchService, cdr, arlasStartupService, arlasOverlayService, arlasColorService)

Parameters

Name Type
arlasCollaborativesearchService ArlasCollaborativesearchService
cdr ChangeDetectorRef
arlasStartupService ArlasStartupService
arlasOverlayService ArlasOverlayService
arlasColorService ArlasColorGeneratorLoader

Defined in

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

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:67


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:62


detailedTimelineContributor

detailedTimelineContributor: DetailedHistogramContributor

Defined in

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


detailedTimelineData

detailedTimelineData: any[] = []

Defined in

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


detailedTimelineHistogramComponent

detailedTimelineHistogramComponent: HistogramComponent

Defined in

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


detailedTimelineIntervalSelection

detailedTimelineIntervalSelection: SelectedOutputValues

Defined in

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


mainCollection

mainCollection: any

Defined in

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


showDetailedTimeline

showDetailedTimeline: boolean = false

Defined in

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


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:54


timelineContributor

timelineContributor: HistogramContributor

Defined in

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


timelineData

timelineData: any[] = []

Defined in

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


timelineHistogramComponent

timelineHistogramComponent: HistogramComponent

Defined in

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


timelineLegend

timelineLegend: CollectionLegend[] = []

Defined in

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


timelineOverlayRef

timelineOverlayRef: ArlasOverlayRef

Defined in

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

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:168


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:207


hideHistogramTooltip

hideHistogramTooltip(): void

Returns

void

Defined in

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


hideShowCollection

hideShowCollection(collectionLegend): void

Parameters

Name Type
collectionLegend CollectionLegend

Returns

void

Defined in

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


ngOnInit

ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

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


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:148


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:159


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:192