arlas-wui-toolkit / Exports / HistogramWidgetComponent

Class: HistogramWidgetComponent

A Widget wraps a component from ARLAS-web-components and bind it to its contributor. The component has thus input data to plot. Note: This component is binded to ARLAS-wui configuration

Implements

• OnInit
• OnDestroy
• AfterViewInit

Table of contents

Constructors

• constructor

Properties

• arlasCollaborativesearchService
• arlasExportCsvService
• componentInputs
• contributor
• currentInterval
• detailedContributor
• detailedHistogramComponent
• detailedTimelineIntervalSelection
• exportCsvEvent
• groupLength
• histogramComponent
• histogramOverlayRef
• noDetail
• outEvents
• position
• showDetailedHistogram
• showExportCsv
• showSpinner
• spinnerOptions
• tooltipEvent
• translate

Methods

• afterDetailedDataPlotted
• emitTooltip
• exportCsv
• hideHistogramTooltip
• initDetailedContributor
• ngAfterViewInit
• ngOnDestroy
• ngOnInit
• onDetailedIntervalBrushed
• onMainIntervalBrushed
• showHistogramTooltip

Constructors

constructor

• new HistogramWidgetComponent(arlasCollaborativesearchService, arlasConfigurationService, cdr, translate, arlasExportCsvService, arlasOverlayService)

Parameters

Name	Type
arlasCollaborativesearchService	ArlasCollaborativesearchService
arlasConfigurationService	ArlasConfigService
cdr	ChangeDetectorRef
translate	TranslateService
arlasExportCsvService	ArlasExportCsvService
arlasOverlayService	ArlasOverlayService

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:110

Properties

arlasCollaborativesearchService

• Protected arlasCollaborativesearchService: ArlasCollaborativesearchService

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:111

---

arlasExportCsvService

• arlasExportCsvService: ArlasExportCsvService

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:115

---

componentInputs

• componentInputs: any

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:60

---

contributor

• contributor: HistogramContributor

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:59

---

currentInterval

• currentInterval: EventEmitter<string>

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:103

---

detailedContributor

• detailedContributor: DetailedHistogramContributor

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:48

---

detailedHistogramComponent

• detailedHistogramComponent: HistogramComponent

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:106

---

detailedTimelineIntervalSelection

• detailedTimelineIntervalSelection: SelectedOutputValues

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:49

---

exportCsvEvent

• exportCsvEvent: Subject<{ contributor: HistogramContributor ; firstLevel: boolean ; type: string }>

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:90

---

groupLength

• groupLength: number

Input

: Angular

Description

Number of widgets in the group to whom this widget belongs

Defined in

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

---

histogramComponent

• histogramComponent: HistogramComponent

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:105

---

histogramOverlayRef

• histogramOverlayRef: ArlasOverlayRef

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:57

---

noDetail

• noDetail: boolean

Input

: Angular

Description

Whether to display a detailed histogram

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:88

---

outEvents

• outEvents: Subject<{ data?: any ; event: string ; origin: string }>

Output

: Angular

Description

Emits an output that comes from the component (ARLAS-web-components). The emitted output has information about the origin which is the contributor id of the component; event the name of the event; and eventually data which contains the emitted data from the component.

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:100

---

position

• position: number

Input

: Angular

Description

Position of the widget in the group

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:70

---

showDetailedHistogram

• showDetailedHistogram: boolean = false

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:47

---

showExportCsv

• showExportCsv: boolean = false

Input

: Angular

Description

Whether we dispylay the export csv button

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:65

---

showSpinner

• showSpinner: boolean = false

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:50

---

spinnerOptions

• spinnerOptions: SpinnerOptions = DEFAULT_SPINNER_OPTIONS

Input

: Angular

Description

Spinner options

Defined in

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

---

tooltipEvent

• tooltipEvent: Subject<HistogramTooltip>

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:55

---

translate

• translate: TranslateService

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:114

Methods

afterDetailedDataPlotted

▸ afterDetailedDataPlotted(e): void

reposition interval of the main histogram after the detail histogram finishes plotting

Parameters

Name	Type
e	string

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:200

---

emitTooltip

▸ emitTooltip(tooltip, e, detailed): void

Parameters

Name	Type
tooltip	any
e	ElementRef<any>
detailed	boolean

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:241

---

exportCsv

▸ exportCsv(contributor): void

Parameters

Name	Type
contributor	HistogramContributor

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:161

---

hideHistogramTooltip

▸ hideHistogramTooltip(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:235

---

initDetailedContributor

▸ initDetailedContributor(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:119

---

ngAfterViewInit

▸ ngAfterViewInit(): void

Returns

void

Implementation of

AfterViewInit.ngAfterViewInit

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:146

---

ngOnDestroy

▸ ngOnDestroy(): void

Returns

void

Implementation of

OnDestroy.ngOnDestroy

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:150

---

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:139

---

onDetailedIntervalBrushed

▸ onDetailedIntervalBrushed(selections): void

Recalculates the new data of detailed histogram and resets its own current selection.

Parameters

Name	Type	Description
selections	SelectedOutputValues[]	List containing only the current selection of detailed histogram

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:173

---

onMainIntervalBrushed

▸ onMainIntervalBrushed(event): void

When the main histogram selection is brushed Hide the detailed histogram if the selection range is greater than 20% of the histogram range

Parameters

Name	Type
event	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:184

---

showHistogramTooltip

▸ showHistogramTooltip(tooltip, e, xOffset, yOffset): void

Parameters

Name	Type
tooltip	HistogramTooltip
e	ElementRef<any>
xOffset	number
yOffset	number

Returns

void

Defined in

projects/arlas-toolkit/src/lib/components/histogram-widget/histogram-widget.component.ts:226