Skip to content

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

Hierarchy

TimelineShortcutComponent

Implements

  • OnInit

Index

Constructors

Properties

Methods


Constructors

constructor

new TimelineShortcutComponent(arlasCollaborativesearchService: ArlasCollaborativesearchService, arlasStartupService: ArlasStartupService, translate: TranslateService): TimelineShortcutComponent

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:46

Parameters:

Name Type
arlasCollaborativesearchService ArlasCollaborativesearchService
arlasStartupService ArlasStartupService
translate TranslateService

Returns: TimelineShortcutComponent


Properties

HIDE_SHOW

● HIDE_SHOW: string = "Show"

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:45


activeDatePicker

● activeDatePicker: boolean = false

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:38

input: : Angular

description: Whether the date picker is enabled


dateFormat

● dateFormat: string

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:33

input: : Angular

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


isShortcutSelected

● isShortcutSelected: boolean = false

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:46


showRemoveIcon

● showRemoveIcon: boolean = false

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:43


showShortcuts

● showShortcuts: boolean = false

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:44


timeShortcuts

● timeShortcuts: Array<StringifiedTimeShortcut>

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:41


timeShortcutsMap

● timeShortcutsMap: Map<string, Array<StringifiedTimeShortcut>>

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:42


timelineComponent

● timelineComponent: any

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:28

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


translate

● translate: TranslateService

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:49


Methods

getKeys

getKeys(map: any): Array<string>

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:112

Gets the list of keys of a Typescript map

Parameters:

Name Type Description
map any

Returns: Array<string>


ngOnInit

ngOnInit(): void

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:60

Returns: void


removeTimelineCollaboration

removeTimelineCollaboration(): void

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:102

Removes all temporal filters of the timeline

Returns: void


setShortcut

setShortcut(shortCut: StringifiedTimeShortcut): void

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:76

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

Parameters:

Name Type Description
shortCut StringifiedTimeShortcut

Returns: void


showSortcuts

showSortcuts(): void

Defined in src/app/components/timeline/timeline-shortcut/timeline-shortcut.component.ts:88

Shows/hides the div containing the shortcuts list

Returns: void