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
- arlasExportCsvService
- chartType
- componentParams
- componentType
- contributor
- contributorId
- contributorType
- donutOverlayRef
- graphParam
- groupLength
- highlightItems
- histogramComponent
- indeterminatedItems
- outEvents
- position
- showExportCsv
- showSwimlaneDropDown
- spinnerOptions
- swimSelected
- swimlanes
- translate
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:109
Properties
arlasExportCsvService
• arlasExportCsvService: ArlasExportCsvService
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:71
componentType
• componentType: any
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:60
contributor
• contributor: any
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:49
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:66
contributorType
• contributorType: any
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:48
donutOverlayRef
• donutOverlayRef: ArlasOverlayRef
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:57
graphParam
• graphParam: any
= {}
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:55
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:96
highlightItems
• highlightItems: Set
<string
>
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:53
histogramComponent
• histogramComponent: HistogramComponent
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:107
indeterminatedItems
• indeterminatedItems: Set
<string
>
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:52
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:104
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:90
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:77
showSwimlaneDropDown
• showSwimlaneDropDown: boolean
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:54
spinnerOptions
• spinnerOptions: SpinnerOptions
input
: Angular
description
Spinner options
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:84
swimSelected
• swimSelected: any
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:50
swimlanes
• swimlanes: any
[] = []
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:51
translate
• translate: TranslateService
Methods
changePowerbarsOperator
▸ changePowerbarsOperator(op
): void
Parameters
Name | Type |
---|---|
op |
"Neq" | "Eq" |
Returns
void
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:228
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:184
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:206
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:210
ngOnInit
▸ ngOnInit(): void
Returns
void
Implementation of
OnInit.ngOnInit
Defined in
projects/arlas-toolkit/src/lib/components/widget/widget.component.ts:144
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:116