arlas-web-components / Exports / ResultItemComponent
Class: ResultItemComponent
Hierarchy
ItemComponent
↳ ResultItemComponent
Implements
OnInit
Table of contents
Constructors
Properties
- CellBackgroundStyleEnum
- HIDE_DETAILS
- NUMBER_FORMAT_CHAR
- SHOW_DETAILS
- actionOnItemEvent
- actions
- activatedActionsPerItem
- borderStyle
- borderStyleEvent
- cellBackgroundStyle
- colorService
- colors
- colorsSaturationWeight
- detailedData
- detailedDataRetriever
- idFieldName
- identifier
- isDetailToggled
- keysToColors
- options
- retrievedDataEvent
- rowItem
- selectedItemPositionEvent
- selectedItems
- selectedItemsEvent
- tableWidth
- translate
- useColorService
Methods
- determinateItem
- getTextColor
- ngOnInit
- retrieveAdditionalInfo
- setSelectedItem
- toggle
- triggerActionOnItem
Constructors
constructor
• new ResultItemComponent(colorService
, translate
)
Parameters
Name | Type |
---|---|
colorService |
ArlasColorService |
translate |
TranslateService |
Overrides
ItemComponent.constructor
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:146
Properties
CellBackgroundStyleEnum
• CellBackgroundStyleEnum: typeof CellBackgroundStyleEnum
= CellBackgroundStyleEnum
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:48
HIDE_DETAILS
• HIDE_DETAILS: "Hide details"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:43
NUMBER_FORMAT_CHAR
• NUMBER_FORMAT_CHAR: string
= NUMBER_FORMAT_CHAR
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:144
SHOW_DETAILS
• SHOW_DETAILS: "Show details"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:47
actionOnItemEvent
• actionOnItemEvent: Subject
<{ action
: Action
; elementidentifier
: ElementIdentifier
}>
Output
Description
Emits the event of applying the specified action on the specified item.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:121
actions
• actions: any
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:139
activatedActionsPerItem
• activatedActionsPerItem: Map
<string
, Set
<string
>>
Input
: Angular
Description
Map
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:109
borderStyle
• borderStyle: string
= 'solid'
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:140
borderStyleEvent
• borderStyleEvent: Subject
<string
>
Output
Description
Emits the border line style depending on the item's toggle state.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:135
cellBackgroundStyle
• cellBackgroundStyle: CellBackgroundStyleEnum
= CellBackgroundStyleEnum.filled
Input
: Angular
Description
The way the cell will be colorized: filled or outlined
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:102
colorService
• colorService: ArlasColorService
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:146
colors
• colors: Object
= {}
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:141
colorsSaturationWeight
• colorsSaturationWeight: number
Input
: Angular
Description
Knowing that saturation scale is [0, 1], colorsSaturationWeight
is a
factor (between 0 and 1) that tightens this scale to [(1-colorsSaturationWeight), 1].
Therefore saturation of generated colors will be within this tightened scale.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:90
detailedData
• detailedData: string
= ''
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:138
detailedDataRetriever
• detailedDataRetriever: DetailedDataRetriever
Input
Description
A detailed-data-retriever object that implements DetailedDataRetriever interface.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:70
idFieldName
• idFieldName: string
Input
Description
Name of the id field.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:64
identifier
• Protected
identifier: string
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:142
isDetailToggled
• isDetailToggled: boolean
= false
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:137
keysToColors
• keysToColors: [string
, string
][]
Input
: Angular
Description
List of [key, color] couples that associates a hex color to each key
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:82
options
• options: ResultListOptions
Input
: Angular
Description
An input to customize the resultlist behaviour
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:54
retrievedDataEvent
• Protected
retrievedDataEvent: Observable
<AdditionalInfo
>
Description
Emits the retrieved detailed data.
Inherited from
ItemComponent.retrievedDataEvent
Defined in
projects/arlas-components/src/lib/components/results/model/itemComponent.ts:30
rowItem
• rowItem: Item
Input
Description
An object representing an Item .
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:59
selectedItemPositionEvent
• selectedItemPositionEvent: Subject
<Item
>
Output
Description
Emits the selected/unselected item.
Deprecated
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:129
selectedItems
• selectedItems: Set
<string
>
Input
Description
List of all selected items in the result-list.component. This component sets directly this list.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:76
selectedItemsEvent
• selectedItemsEvent: Subject
<Set
<string
>>
Output
Description
Emits the list of selected items in result-list.component.
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:115
tableWidth
• tableWidth: number
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:110
translate
• translate: TranslateService
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:146
useColorService
• useColorService: boolean
= false
Input
: Angular
Description
Whether to allow colorizing the cells of the item (the row) according to the terms displayed
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:96
Methods
determinateItem
▸ determinateItem(): void
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:177
getTextColor
▸ getTextColor(key
): string
Parameters
Name | Type |
---|---|
key |
any |
Returns
string
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:185
ngOnInit
▸ ngOnInit(): void
Returns
void
Implementation of
OnInit.ngOnInit
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:151
retrieveAdditionalInfo
▸ retrieveAdditionalInfo(detailedDataRetriever
, item
): void
Parameters
Name | Type |
---|---|
detailedDataRetriever |
DetailedDataRetriever |
item |
Item |
Returns
void
Inherited from
ItemComponent.retrieveAdditionalInfo
Defined in
projects/arlas-components/src/lib/components/results/model/itemComponent.ts:45
setSelectedItem
▸ setSelectedItem(): void
Returns
void
Overrides
ItemComponent.setSelectedItem
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:171
toggle
▸ toggle(): void
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:158
triggerActionOnItem
▸ triggerActionOnItem(action
): void
Parameters
Name | Type |
---|---|
action |
Action |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-item/result-item.component.ts:193