arlas-web-components / Exports / ResultListComponent
Class: ResultListComponent
ResultList component allows to structure data in a filterable and sortable table. Items can be represented as rows or grids and are multi-selectable. For both list and grid modes, each item has detailed data that can be displayed in a togglable space.
Implements
OnInit
DoCheck
OnChanges
AfterViewInit
Table of contents
Constructors
Properties
- COLUMN_ACTIONS_HEIGHT
- COLUMN_NAME_HEIGHT
- CONTAIN_FIT
- FILTERS_HEIGHT
- FILTER_ON
- GEOSORT_ACTION
- GEOSORT_BUTTON
- GEO_DISTANCE
- GLOBAL_ACTIONS
- GRID_MODE
- HEIGHT_FIT
- LIST_MODE
- ModeEnum
- PageEnum
- SortEnum
- TAIL_HEIGHT
- ThumbnailFitEnum
- WIDTH_FIT
- actionOnItemEvent
- activatedActionsPerItem
- allItemsChecked
- borderStyle
- cellBackgroundStyle
- changeResultMode
- clickOnItemEvent
- clickOnTile
- colorsSaturationWeight
- columnFilterChanged
- columns
- consultedItemEvent
- currentSortedColumn
- defautMode
- detailedDataRetriever
- detailedGridHeight
- displayFilters
- displayListGrid
- displayThead
- dropDownMapValues
- fetchState
- fieldsConfiguration
- fieldsList
- filtersMap
- geoAutoSortEvent
- geoSortEvent
- globalActionEvent
- globalActionsList
- hasGridMode
- highlightItems
- indeterminatedItems
- isBodyHidden
- isDetailledGridOpen
- isGeoSortActivated
- isGeoSortEnabled
- isNextPageRequested
- isPreviousPageRequested
- isShiftDown
- items
- keysToColors
- lastSortedColumn
- loadAnimationConfig
- moreDataEvent
- nLastLines
- nbGridColumns
- nbLinesBeforeFetch
- onChangeItems
- onListLoaded
- onResultListUpdate
- options
- paginationEvent
- resultMode
- rowItemList
- scrollOptions
- selectedGridItem
- selectedItems
- selectedItemsEvent
- setFiltersEvent
- showEmptyGroup
- sortColumnEvent
- sortedColumn
- tableWidth
- tbodyHeight
- theadHeight
- thumbnailFit
- thumbnailFitEvent
- translate
- useColorService
- visibleItems
Methods
- byFieldName
- clearSelection
- closeDetail
- columnChanged
- emitThumbnailsFitStatus
- emitVisibleItems
- geoSort
- ngAfterViewInit
- ngDoCheck
- ngOnChanges
- ngOnInit
- onClickItem
- onEnterItem
- onLeaveItem
- paginate
- selectAllItems
- selectInBetween
- setBorderStyle
- setConsultedItem
- setDirection
- setFilters
- setGeoSortAction
- setGlobalAction
- setSelectedGridItem
- setSelectedItems
- setSortedColumn
- shiftDown
- shiftUp
- sort
- triggerActionOnItem
- whichMode
Constructors
constructor
• new ResultListComponent(iterableRowsDiffer
, iterableColumnsDiffer
, el
, colorService
, translate
, notifier
, cdr
)
Parameters
Name | Type |
---|---|
iterableRowsDiffer |
IterableDiffers |
iterableColumnsDiffer |
IterableDiffers |
el |
ElementRef <any > |
colorService |
ArlasColorService |
translate |
TranslateService |
notifier |
ResultlistNotifierService |
cdr |
ChangeDetectorRef |
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:498
Properties
COLUMN_ACTIONS_HEIGHT
• COLUMN_ACTIONS_HEIGHT: number
= 52
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:108
COLUMN_NAME_HEIGHT
• COLUMN_NAME_HEIGHT: number
= 27
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:113
CONTAIN_FIT
• CONTAIN_FIT: "Fit the whole thumbnail to the tile"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:88
FILTERS_HEIGHT
• FILTERS_HEIGHT: number
= 50
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:118
FILTER_ON
• FILTER_ON: "Filter on"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:66
GEOSORT_ACTION
• GEOSORT_ACTION: "Geo sort action"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:75
GEOSORT_BUTTON
• GEOSORT_BUTTON: "Geo-sort"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:103
GEO_DISTANCE
• GEO_DISTANCE: string
= 'geodistance'
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:61
GLOBAL_ACTIONS
• GLOBAL_ACTIONS: "Global actions"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:71
GRID_MODE
• GRID_MODE: "Grid mode"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:79
HEIGHT_FIT
• HEIGHT_FIT: "Fit the thumbnail's height to the tile"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:98
LIST_MODE
• LIST_MODE: "List mode"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:83
ModeEnum
• ModeEnum: typeof ModeEnum
= ModeEnum
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:475
PageEnum
• PageEnum: typeof PageEnum
= PageEnum
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:477
SortEnum
• SortEnum: typeof SortEnum
= SortEnum
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:478
TAIL_HEIGHT
• TAIL_HEIGHT: number
= 30
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:123
ThumbnailFitEnum
• ThumbnailFitEnum: typeof ThumbnailFitEnum
= ThumbnailFitEnum
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:476
WIDTH_FIT
• WIDTH_FIT: "Fit the thumbnail's width to the tile"
Constant
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:93
actionOnItemEvent
• actionOnItemEvent: Subject
<{ action
: Action
; elementidentifier
: ElementIdentifier
}>
Output
: Angular
Description
Emits the event of applying the specified action on the specified item.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:408
activatedActionsPerItem
• activatedActionsPerItem: Map
<string
, Set
<string
>>
Input
: Angular
Description
Map
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:234
allItemsChecked
• allItemsChecked: boolean
= false
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:487
borderStyle
• borderStyle: string
= 'solid'
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:489
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-list/result-list.component.ts:320
changeResultMode
• changeResultMode: Subject
<ModeEnum
>
Output
: Angular
Description
Emits the event of clicking on the switch mode button. Emits the new mode (grid or list).
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:433
clickOnItemEvent
• clickOnItemEvent: Subject
<ElementIdentifier
>
Output
: Angular
Description
Emits the item that is clicked on.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:381
clickOnTile
• clickOnTile: Subject
<Item
>
Output
: Angular
Description
Emits the event of clicking on a grid tile.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:427
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-list/result-list.component.ts:308
columnFilterChanged
• columnFilterChanged: Subject
<Column
>
Output
: Angular
Description
Emits the event of applying the specified global action on the selected items.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:421
columns
• columns: Column
[]
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:465
consultedItemEvent
• consultedItemEvent: Subject
<ElementIdentifier
>
Output
: Angular
Description
Emits one item identifier that is hovered..
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:375
currentSortedColumn
• currentSortedColumn: Column
Input
: Angular
Description
The column that is currently sorted on
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:275
defautMode
• defautMode: ModeEnum
Input
: Angular
Description
Mode of representation : list
or grid
.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:246
detailedDataRetriever
• detailedDataRetriever: DetailedDataRetriever
= null
Input
: Angular
Description
A detailed-data-retriever object that implements DetailedDataRetriever interface.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:216
detailedGridHeight
• detailedGridHeight: number
= 300
Input
: Angular
Description
Height of the detail grid div (Grid Mode).
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:197
displayFilters
• displayFilters: boolean
= true
Input
: Angular
Description
Whether filters on list are displayed.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:257
displayListGrid
• displayListGrid: string
= 'inline'
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:490
displayThead
• displayThead: boolean
= true
Input
: Angular
Description
A boolean to show or hide thead of table
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:294
dropDownMapValues
• dropDownMapValues: Map
<string
, Observable
<string
[]>>
Input
: Angular
Description
A map of fieldName- Observable of array value for dropdown filter
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:289
fetchState
• fetchState: Object
Type declaration
Name | Type |
---|---|
endListDown |
boolean |
endListUp |
boolean |
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:139
fieldsConfiguration
• fieldsConfiguration: FieldsConfiguration
Input
: Angular
Description
A configuration object that sets id field, title field and urls to images && thumbnails
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:168
fieldsList
• fieldsList: { columnName
: string
; dataType
: string
; fieldName
: string
; useColorService?
: boolean
}[]
Input
: Angular
Description
List of the fields displayed in the table (including the id field) - fieldName : Name/path of the field to add to list - columnName : Name of the field that will be displayed on the list column - dataType : Unit of the field values if it exists (degree, percentage, etc) - useColorService : Whether to colorize values on cells of the list with a color generated from the field value NOTE : This list should include the ID field. It will be the id of each item
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:149
filtersMap
• filtersMap: Map
<string
, ItemDataType
>
Input
: Angular
Description
A fieldName-fieldValue map of fields to filter.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:282
geoAutoSortEvent
• geoAutoSortEvent: Subject
<boolean
>
Output
: Angular
Description
Emits the event of geo-sorting data.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:363
geoSortEvent
• geoSortEvent: Subject
<string
>
Output
: Angular
Description
Emits the event of geo-sorting data.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:357
globalActionEvent
• globalActionEvent: Subject
<Action
>
Output
: Angular
Description
Emits the event of applying the specified globalb action on the selected items.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:415
globalActionsList
• globalActionsList: Action
[]
Input
: Angular
Description
List of actions to apply on the selected items.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:209
hasGridMode
• hasGridMode: boolean
= false
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:485
highlightItems
• highlightItems: Set
<string
>
Input
: Angular
Description
List of items ids to be highlighted.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:240
indeterminatedItems
• indeterminatedItems: Set
<string
>
Input
: Angular
Description
List of items ids that are in a indeterminated status.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:222
isBodyHidden
• isBodyHidden: boolean
Input
: Angular
Description
Whether the body table is hidden or not.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:252
isDetailledGridOpen
• isDetailledGridOpen: boolean
= false
Input
Description
Whether display the detailled part in grid mode.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:335
isGeoSortActivated
• isGeoSortActivated: boolean
= false
Input
: Angular
Description
Whether the sort on the geometry is activated
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:269
isGeoSortEnabled
• isGeoSortEnabled: boolean
= false
Input
: Angular
Description
Whether the sort on the geometry is enabled.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:263
isNextPageRequested
• isNextPageRequested: boolean
= false
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:483
isPreviousPageRequested
• isPreviousPageRequested: boolean
= false
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:484
isShiftDown
• isShiftDown: boolean
= false
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:491
items
• items: Item
[]
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:466
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-list/result-list.component.ts:300
lastSortedColumn
• lastSortedColumn: Column
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:468
loadAnimationConfig
• loadAnimationConfig: Object
Type declaration
Name | Type |
---|---|
animationType |
string |
backdropBackgroundColour |
string |
backdropBorderRadius |
string |
primaryColour |
string |
secondaryColour |
string |
tertiaryColour |
string |
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:126
moreDataEvent
• moreDataEvent: Subject
<number
>
Output
: Angular
Description
Emits the request of more data to load. The emitted number is the number of times this event has been emitted.
Deprecated
moreDataEvent can be replaced by paginationEvent
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:394
nLastLines
• nLastLines: number
Input
: Angular
Description
The number of items left on the list/grid when scrolling up or down upon which loading new data is triggered.
When scrolling up or down, once there is nLastLines
items left at the top or bottom of the list, previous/next data is loaded.
Deprecated
nLastLines is deprecated and used only if nbLinesBeforeFetch
is not set
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:183
nbGridColumns
• nbGridColumns: number
= 4
Input
: Angular
Description
Number of grid columns (Grid Mode).
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:203
nbLinesBeforeFetch
• nbLinesBeforeFetch: number
= 5
Input
: Angular
Description
The number of items left on the list/grid when scrolling up or down upon which loading new data is triggered.
When scrolling up or down, once there is nbLinesBeforeFetch
items left at the top or bottom of the list, previous/next
data is loaded.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:191
onChangeItems
• onChangeItems: Subject
<any
[]>
Output
: Angular
Description
Emits on changes rowItemList current value.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:445
onListLoaded
• onListLoaded: EventEmitter
<boolean
>
Output
: Angular
Description
Emits when the list is ready.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:463
onResultListUpdate
• onResultListUpdate: EventEmitter
<boolean
>
Output
: Angular
Description
Emits when result list is updated.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:457
options
• options: ResultListOptions
Input
: Angular
Description
An input to customize the resultlist
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:137
paginationEvent
• paginationEvent: Subject
<PageQuery
>
Output
: Angular
Description
Emits the request of a new page to load. The emitted PageQuery contains the reference item from which the new page is loaded and whether it is the previous or the next page.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:402
resultMode
• resultMode: ModeEnum
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:486
rowItemList
• rowItemList: Map
<string
, ItemDataType
>[]
Input
: Angular
Description
List of fieldName-fieldValue map. Each map corresponds to a row/grid.
Note
In order to apply selectInBetween
method properly, this list must be ascendingly sorted on the item identifier.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:161
scrollOptions
• scrollOptions: Object
Type declaration
Name | Type |
---|---|
maintainScrollDownPosition |
boolean |
maintainScrollUpPosition |
boolean |
nbLines |
number |
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:131
selectedGridItem
• selectedGridItem: Item
Input
: Angular
Description
A item to show detail
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:325
selectedItems
• selectedItems: Set
<string
>
Input
: Angular
Description
List of items ids that are in a selected status.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:228
selectedItemsEvent
• selectedItemsEvent: Subject
<string
[]>
Output
: Angular
Description
Emits the list of items identifiers whose checkboxes are selected.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:369
setFiltersEvent
• setFiltersEvent: Subject
<Map
<string
, ItemDataType
>>
Output
: Angular
Description
Emits the filtred fields map (fieldName-fieldValue map).
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:387
showEmptyGroup
• showEmptyGroup: boolean
= false
Input
Description
Whether display group with no detail.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:330
sortColumnEvent
• sortColumnEvent: Subject
<{ fieldName
: string
; sortDirection
: SortEnum
}>
Output
: Angular
Description
Emits the event of sorting data on the specified column.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:350
sortedColumn
• sortedColumn: Object
Type declaration
Name | Type |
---|---|
fieldName |
string |
sortDirection |
SortEnum |
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:467
tableWidth
• tableWidth: number
= null
Input
: Angular
Description
The table width. If not specified, the tableWidth value is equal to container width.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:175
tbodyHeight
• tbodyHeight: number
= null
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:472
theadHeight
• theadHeight: number
= null
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:473
thumbnailFit
• thumbnailFit: ThumbnailFitEnum
= ThumbnailFitEnum.contain
Input
Description
How to fit the thumbnail to the tile:
- height
fit the height of the thumbnail.
- width
fit the width of the thumbnail.
- contain
fit the wholethumbnail.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:344
thumbnailFitEvent
• thumbnailFitEvent: Subject
<ThumbnailFitEnum
>
Output
: Angular
Description
Emits when changing how thumbnails fit in their div.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:451
translate
• translate: TranslateService
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:499
useColorService
• useColorService: boolean
= false
Input
: Angular
Description
Whether to allow colorizing cells and the grid tile of the list.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:314
visibleItems
• visibleItems: Subject
<Item
[]>
Output
: Angular
Description
Emits the current visible items in the viewport.
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:439
Methods
byFieldName
▸ byFieldName(item1
, item2
): boolean
Parameters
Name | Type |
---|---|
item1 |
Column |
item2 |
Column |
Returns
boolean
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:939
clearSelection
▸ clearSelection(): void
Description
Clear set of selection
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:930
closeDetail
▸ closeDetail(isClosed
): void
Parameters
Name | Type |
---|---|
isClosed |
boolean |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:851
columnChanged
▸ columnChanged(colum
): void
Description
Emits the column when a filter is addedd
Parameters
Name | Type |
---|---|
colum |
Column |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:923
emitThumbnailsFitStatus
▸ emitThumbnailsFitStatus(fitChange
): void
Parameters
Name | Type |
---|---|
fitChange |
MatButtonToggleChange |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:542
emitVisibleItems
▸ emitVisibleItems(items
): void
Parameters
Name | Type |
---|---|
items |
Item [] |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:674
geoSort
▸ geoSort(): void
Description
Emits the request event of geo-sorting
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:781
ngAfterViewInit
▸ ngAfterViewInit(): void
Returns
void
Implementation of
AfterViewInit.ngAfterViewInit
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:536
ngDoCheck
▸ ngDoCheck(): void
Returns
void
Implementation of
DoCheck.ngDoCheck
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:629
ngOnChanges
▸ ngOnChanges(changes
): void
Parameters
Name | Type |
---|---|
changes |
SimpleChanges |
Returns
void
Implementation of
OnChanges.ngOnChanges
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:547
ngOnInit
▸ ngOnInit(): void
Returns
void
Implementation of
OnInit.ngOnInit
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:525
onClickItem
▸ onClickItem(item
): void
Description
Called when item is clicked. It is instant compared to other events
Parameters
Name | Type | Description |
---|---|---|
item |
Item |
Item clicked on |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:826
onEnterItem
▸ onEnterItem(item
): void
Description
called on hovering an item : its sets the items actions + emits the item's identifier
Parameters
Name | Type | Description |
---|---|---|
item |
Item |
hovered item |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:809
onLeaveItem
▸ onLeaveItem(item
): void
Description
called on leaving an item : emits the item's identifier
Parameters
Name | Type | Description |
---|---|---|
item |
Item |
item previously hovered |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:818
paginate
▸ paginate(itemData
, whichPage
): void
Description
Emits the event of asking for next or previous page of items
Parameters
Name | Type | Description |
---|---|---|
itemData |
Map <string , ItemDataType > |
- |
whichPage |
PageEnum |
: Whether to fetch the next or previous page |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:683
selectAllItems
▸ selectAllItems(): void
Description
Selects all the items
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:876
selectInBetween
▸ selectInBetween(): void
Description
Selects all the items between the farest and nearest selected items
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:892
setBorderStyle
▸ setBorderStyle(borderStyle
): void
Description
Sets the border style of rows
Parameters
Name | Type |
---|---|
borderStyle |
any |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:837
setConsultedItem
▸ setConsultedItem(identifier
): void
Description
Sets and emits the hovered item's identifier
Parameters
Name | Type |
---|---|
identifier |
string |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:797
setDirection
▸ setDirection(direction
): void
Parameters
Name | Type |
---|---|
direction |
string |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:759
setFilters
▸ setFilters(filtersMap
): void
Description
Sets and emits the [fieldName, filterValue] map of filtered fields
Parameters
Name | Type |
---|---|
filtersMap |
Map <string , ItemDataType > |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:716
setGeoSortAction
▸ setGeoSortAction(): void
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:704
setGlobalAction
▸ setGlobalAction(action
): void
Description
Sets and emits the action to apply to all selected items
Parameters
Name | Type |
---|---|
action |
Action |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:700
setSelectedGridItem
▸ setSelectedGridItem(item
): void
Description
Sets the selected grid item
Parameters
Name | Type |
---|---|
item |
Item |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:844
setSelectedItems
▸ setSelectedItems(selectedItems
, stopPropagation?
): void
Description
Sets and emits the identifiers list of selected items
Parameters
Name | Type |
---|---|
selectedItems |
Set <string > |
stopPropagation? |
boolean |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:724
setSortedColumn
▸ setSortedColumn(event
): void
Parameters
Name | Type |
---|---|
event |
MatSelectChange |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:766
shiftDown
▸ shiftDown(_
): void
Parameters
Name | Type |
---|---|
_ |
any |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:515
shiftUp
▸ shiftUp(event
): void
Parameters
Name | Type |
---|---|
event |
KeyboardEvent |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:520
sort
▸ sort(paramSortedColumn
): void
Description
Emits the column to sort on and the sort direction
Parameters
Name | Type |
---|---|
paramSortedColumn |
Column |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:744
triggerActionOnItem
▸ triggerActionOnItem(actionOnItem
): void
Description
Emits which action to apply on which item/product
Parameters
Name | Type |
---|---|
actionOnItem |
Object |
actionOnItem.action |
Action |
actionOnItem.elementidentifier |
ElementIdentifier |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:693
whichMode
▸ whichMode(toggleChangeEvent
): void
Description
Sets the display style according to the mode
Parameters
Name | Type |
---|---|
toggleChangeEvent |
MatButtonToggleChange |
Returns
void
Defined in
projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:861