arlas-wui-toolkit / Exports / TimelineShortcutComponent

Class: TimelineShortcutComponent

This component contains shortcut labels that allow to apply predefined temporal filters on a timeline (Last year, Last month, Today, etc ...). It also displays the start and end values of the current selection on the timeline. And if enabled, a datepicker is allowed on those start and end values. This component is used internally in TimelineComponent

Implements

  • OnInit

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new TimelineShortcutComponent(arlasCollaborativesearchService, arlasStartupService, translate)

Parameters

Name Type
arlasCollaborativesearchService ArlasCollaborativesearchService
arlasStartupService ArlasStartupService
translate TranslateService

Defined in

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

Properties

HIDE_SHOW

• HIDE_SHOW: string = 'Show'

Defined in

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

activeDatePicker

• activeDatePicker: boolean = false

Input

: Angular

Description

Whether the date picker is enabled

Defined in

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

dateFormat

• dateFormat: string

Input

: Angular

Description

Optional input. Sets the format of start/end date values of the timeline.

Defined in

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

isDisplayHistogram

• isDisplayHistogram: boolean = true

Input

: Angular

Description

Whether to display the timelines' histogram

Defined in

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

isDisplayHistogramChange

• isDisplayHistogramChange: EventEmitter<any>

Output

: Angular

Description

Emits when the value of isDisplayHistogram changes

Defined in

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

isShortcutSelected

• isShortcutSelected: boolean = false

Defined in

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

removeCollaboration

• removeCollaboration: EventEmitter<void>

Output

: Angular

Description

Emits when the timeline collaboration is removed

Defined in

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

showRemoveIcon

• showRemoveIcon: boolean = false

Defined in

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

showShortcuts

• showShortcuts: boolean = false

Defined in

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

timeShortcuts

• timeShortcuts: StringifiedTimeShortcut[]

Defined in

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

timeShortcutsMap

• timeShortcutsMap: Map<string, StringifiedTimeShortcut[]>

Defined in

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

timeZone

• timeZone: string = 'UTC'

Defined in

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

timelineComponent

• timelineComponent: any

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-shortcut/timeline-shortcut.component.ts:47

timelineContributor

• timelineContributor: HistogramContributor

Defined in

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

translate

• translate: TranslateService

Defined in

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

Methods

getKeys

▸ getKeys(map): string[]

Gets the list of keys of a Typescript map

Parameters

Name Type
map any

Returns

string[]

Defined in

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

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

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

removeTimelineCollaboration

▸ removeTimelineCollaboration(): void

Removes all temporal filters of the timeline

Returns

void

Defined in

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

setShortcut

▸ setShortcut(shortCut): void

Applies a temporal filter on timeline according to the chosen shortcut.

Parameters

Name Type
shortCut StringifiedTimeShortcut

Returns

void

Defined in

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

showSortcuts

▸ showSortcuts(): void

Shows/hides the div containing the shortcuts list

Returns

void

Defined in

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

toggleTimeline

▸ toggleTimeline(): void

Returns

void

Defined in

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