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

Table of contents

Constructors

Properties

Methods

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:107

Properties

arlasExportCsvService

• arlasExportCsvService: ArlasExportCsvService

Defined in

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

componentInputs

• componentInputs: any

Defined in

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

contributor

• contributor: HistogramContributor

Defined in

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

currentInterval

• currentInterval: EventEmitter<string>

Defined in

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

detailedContributor

• detailedContributor: DetailedHistogramContributor

Defined in

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

detailedHistogramComponent

• detailedHistogramComponent: HistogramComponent

Defined in

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

detailedTimelineIntervalSelection

• detailedTimelineIntervalSelection: SelectedOutputValues

Defined in

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

exportCsvEvent

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

Defined in

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

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:75

histogramComponent

• histogramComponent: HistogramComponent

Defined in

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

histogramOverlayRef

• histogramOverlayRef: ArlasOverlayRef

Defined in

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

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:87

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:99

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:69

showDetailedHistogram

• showDetailedHistogram: boolean = false

Defined in

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

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:64

showSpinner

• showSpinner: boolean = false

Defined in

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

spinnerOptions

• spinnerOptions: SpinnerOptions

Input

: Angular

Description

Spinner options

Defined in

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

tooltipEvent

• tooltipEvent: Subject<HistogramTooltip>

Defined in

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

translate

• translate: TranslateService

Defined in

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

Methods

afterDetailedDataPlotted

▸ afterDetailedDataPlotted(e): void

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

Parameters

Name Type
e any

Returns

void

Defined in

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

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:230

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:150

hideHistogramTooltip

▸ hideHistogramTooltip(): void

Returns

void

Defined in

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

initDetailedContributor

▸ initDetailedContributor(): void

Returns

void

Defined in

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

ngOnDestroy

▸ ngOnDestroy(): void

Returns

void

Implementation of

OnDestroy.ngOnDestroy

Defined in

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

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

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

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:162

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:173

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:215