Skip to content

arlas-wui-toolkit > "src/app/components/timeline/timeline/timeline.component" > 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 ...)

Hierarchy

TimelineComponent

Implements

  • OnInit

Index

Constructors

Properties

Methods


Constructors

constructor

new TimelineComponent(arlasCollaborativesearchService: ArlasCollaborativesearchService, cdr: ChangeDetectorRef, arlasStartupService: ArlasStartupService): TimelineComponent

Defined in src/app/components/timeline/timeline/timeline.component.ts:74

Parameters:

Name Type
arlasCollaborativesearchService ArlasCollaborativesearchService
cdr ChangeDetectorRef
arlasStartupService ArlasStartupService

Returns: TimelineComponent


Properties

activeDatePicker

● activeDatePicker: boolean = false

Defined in src/app/components/timeline/timeline/timeline.component.ts:63

input: : Angular

description: Whether the date picker is enabled


detailedTimelineComponent

● detailedTimelineComponent: TimelineConfiguration

Defined in src/app/components/timeline/timeline/timeline.component.ts:58

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


detailedTimelineContributor

● detailedTimelineContributor: DetailedHistogramContributor

Defined in src/app/components/timeline/timeline/timeline.component.ts:68


detailedTimelineHistogramComponent

● detailedTimelineHistogramComponent: HistogramComponent

Defined in src/app/components/timeline/timeline/timeline.component.ts:65


detailedTimelineIntervalSelection

● detailedTimelineIntervalSelection: SelectedOutputValues

Defined in src/app/components/timeline/timeline/timeline.component.ts:70


showDetailedTimeline

● showDetailedTimeline: boolean = false

Defined in src/app/components/timeline/timeline/timeline.component.ts:67


timelineComponent

● timelineComponent: TimelineConfiguration

Defined in src/app/components/timeline/timeline/timeline.component.ts:50

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


timelineContributor

● timelineContributor: HistogramContributor

Defined in src/app/components/timeline/timeline/timeline.component.ts:69


timelineHistogramComponent

● timelineHistogramComponent: HistogramComponent

Defined in src/app/components/timeline/timeline/timeline.component.ts:64


Methods

afterDetailedDataPlotted

afterDetailedDataPlotted(e: any): void

Defined in src/app/components/timeline/timeline/timeline.component.ts:116

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


ngOnInit

ngOnInit(): void

Defined in src/app/components/timeline/timeline/timeline.component.ts:80

Returns: void


onDetailedIntervalBrushed

onDetailedIntervalBrushed(selections: SelectedOutputValues[]): void

Defined in src/app/components/timeline/timeline/timeline.component.ts:97

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


onTimelineIntervalBrushed

onTimelineIntervalBrushed(selections: SelectedOutputValues[]): void

Defined in src/app/components/timeline/timeline/timeline.component.ts:107

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