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
- activeDatePicker
- detailedTimelineComponent
- detailedTimelineContributor
- detailedTimelineData
- detailedTimelineHistogramComponent
- detailedTimelineIntervalSelection
- isDisplayHistogram
- isDisplayHistogramChange
- mainCollection
- showDetailedTimeline
- timelineComponent
- timelineContributor
- timelineData
- timelineHistogramComponent
- timelineLegend
- timelineOverlayRef
- units
Methods
- afterDetailedDataPlotted
- emitTooltip
- hideHistogramTooltip
- hideShowCollection
- ngOnInit
- onDetailedIntervalBrushed
- onTimelineIntervalBrushed
- showHistogramTooltip
- toggleTimeline
Constructors
constructor
• new TimelineComponent(arlasCollaborativesearchService
, cdr
, arlasStartupService
, arlasOverlayService
, arlasColorService
)
Parameters
Name | Type |
---|---|
arlasCollaborativesearchService |
ArlasCollaborativesearchService |
cdr |
ChangeDetectorRef |
arlasStartupService |
ArlasStartupService |
arlasOverlayService |
ArlasOverlayService |
arlasColorService |
ArlasColorService |
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:102
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:66
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:61
detailedTimelineContributor
• detailedTimelineContributor: DetailedHistogramContributor
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:90
detailedTimelineData
• detailedTimelineData: any
[] = []
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:94
detailedTimelineHistogramComponent
• detailedTimelineHistogramComponent: HistogramComponent
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:87
detailedTimelineIntervalSelection
• detailedTimelineIntervalSelection: SelectedOutputValues
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:78
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:84
mainCollection
• mainCollection: any
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:100
showDetailedTimeline
• showDetailedTimeline: boolean
= false
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:89
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:53
timelineContributor
• timelineContributor: HistogramContributor
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:91
timelineData
• timelineData: any
[] = []
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:93
timelineHistogramComponent
• timelineHistogramComponent: HistogramComponent
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:86
timelineLegend
• timelineLegend: CollectionLegend
[] = []
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:99
timelineOverlayRef
• timelineOverlayRef: ArlasOverlayRef
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:98
units
• units: CollectionUnit
[]
Input
: Angular
Description
Units to use as display names for the timeline legend
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:72
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:184
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:223
hideHistogramTooltip
▸ hideHistogramTooltip(): void
Returns
void
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:217
hideShowCollection
▸ hideShowCollection(collectionLegend
): void
Parameters
Name | Type |
---|---|
collectionLegend |
CollectionLegend |
Returns
void
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:234
ngOnInit
▸ ngOnInit(): void
Returns
void
Implementation of
OnInit.ngOnInit
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:107
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:164
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:175
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:208
toggleTimeline
▸ toggleTimeline(): void
Returns
void
Defined in
projects/arlas-toolkit/src/lib/components/timeline/timeline/timeline.component.ts:292