arlas-wui-toolkit / Exports / WidgetComponent

Class: WidgetComponent

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

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new WidgetComponent(arlasStartupService, cdr, arlasCollaborativesearchService, arlasOverlayService, translate, arlasExportCsvService)

Parameters

Name Type
arlasStartupService ArlasStartupService
cdr ChangeDetectorRef
arlasCollaborativesearchService ArlasCollaborativesearchService
arlasOverlayService ArlasOverlayService
translate TranslateService
arlasExportCsvService ArlasExportCsvService

Defined in

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

Properties

arlasExportCsvService

• arlasExportCsvService: ArlasExportCsvService

Defined in

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

chartType

• chartType: typeof ChartType = ChartType

Defined in

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

componentParams

• componentParams: any

Input

: Angular

Description

Inputs of one of the ARLAS-web-components

Defined in

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

componentType

• componentType: string

Defined in

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

contributor

• contributor: any

Defined in

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

contributorId

• contributorId: string

Input

: Angular

Description

Identifier of the contributor that serves data to the component

Defined in

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

contributorType

• contributorType: string

Defined in

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

donutOverlayRef

• donutOverlayRef: ArlasOverlayRef

Defined in

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

graphParam

• graphParam: any = {}

Defined in

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

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/widget/widget.component.ts:95

highlightItems

• highlightItems: Set<string>

Defined in

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

histogramComponent

• histogramComponent: HistogramComponent

Defined in

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

indeterminatedItems

• indeterminatedItems: Set<string>

Defined in

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

metricApproximate

• metricApproximate: boolean = false

Defined in

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

noDetail

• noDetail: boolean

Input

: Angular

Description

Whether the widget has to display a detailed version of itself. Currently only used for histograms

Defined in

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

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/widget/widget.component.ts:109

position

• position: number

Input

: Angular

Description

Position of the widget in the group

Defined in

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

showExportCsv

• showExportCsv: boolean = false

Input

: Angular

Description

Whether we dispylay the export csv button

Defined in

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

showSwimlaneDropDown

• showSwimlaneDropDown: boolean

Defined in

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

spinnerOptions

• spinnerOptions: SpinnerOptions = DEFAULT_SPINNER_OPTIONS

Input

: Angular

Description

Spinner options

Defined in

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

swimSelected

• swimSelected: any

Defined in

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

swimlanes

• swimlanes: any[] = []

Defined in

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

translate

• translate: TranslateService

Defined in

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

Methods

changeMetricsTableOperator

▸ changeMetricsTableOperator(op): void

Parameters

Name Type
op "Neq" | "Eq"

Returns

void

Defined in

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

changePowerbarsOperator

▸ changePowerbarsOperator(op): void

Parameters

Name Type
op "Neq" | "Eq"

Returns

void

Defined in

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

changeSwimlane

▸ changeSwimlane(swimlaneName): void

Description

Changes swimlane from the pool of swimlanes defined in SwimlaneContributor configuration.

Parameters

Name Type Description
swimlaneName any The name of swimlane.

Returns

void

Defined in

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

emitEvent

▸ emitEvent(source, event, data): void

Emits the components output events.

Parameters

Name Type Description
source string Contributor identifier
event string Name of the event
data any Emitted data

Returns

void

Defined in

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

exportCsv

▸ exportCsv(contributor, stayAtFirstLevel, componentType, contributorType?): void

Parameters

Name Type
contributor Contributor
stayAtFirstLevel boolean
componentType string
contributorType? string

Returns

void

Defined in

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

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

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

showDonutTooltip

▸ showDonutTooltip(tooltip, e): void

Parameters

Name Type
tooltip ARLASDonutTooltip
e ElementRef<any>

Returns

void

Defined in

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