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

Methods

Constructors

constructor

• new ResultListComponent(iterableRowsDiffer, iterableColumnsDiffer, el, colorService, translate, cdr)

Parameters

Name Type
iterableRowsDiffer IterableDiffers
iterableColumnsDiffer IterableDiffers
el ElementRef<any>
colorService ArlasColorService
translate TranslateService
cdr ChangeDetectorRef

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:485

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

COLUMN_NAME_HEIGHT

• COLUMN_NAME_HEIGHT: number = 27

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:112

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

FILTERS_HEIGHT

• FILTERS_HEIGHT: number = 50

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:117

FILTER_ON

• FILTER_ON: "Filter on"

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:65

GEOSORT_ACTION

• GEOSORT_ACTION: "Geo sort action"

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:74

GEOSORT_BUTTON

• GEOSORT_BUTTON: "Geo-sort"

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:102

GEO_DISTANCE

• GEO_DISTANCE: string = 'geodistance'

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:60

GLOBAL_ACTIONS

• GLOBAL_ACTIONS: "Global actions"

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:70

GRID_MODE

• GRID_MODE: "Grid mode"

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:78

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

LIST_MODE

• LIST_MODE: "List mode"

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:82

ModeEnum

• ModeEnum: typeof ModeEnum = ModeEnum

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:462

PageEnum

• PageEnum: typeof PageEnum = PageEnum

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:464

SortEnum

• SortEnum: typeof SortEnum = SortEnum

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:465

TAIL_HEIGHT

• TAIL_HEIGHT: number = 30

Constant

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:122

ThumbnailFitEnum

• ThumbnailFitEnum: typeof ThumbnailFitEnum = ThumbnailFitEnum

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:463

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

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

allItemsChecked

• allItemsChecked: boolean = false

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:474

borderStyle

• borderStyle: string = 'solid'

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:476

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

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

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

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

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

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

columns

• columns: Column[]

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:452

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

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

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

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

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

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

displayListGrid

• displayListGrid: string = 'inline'

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:477

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

• 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:282

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

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

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

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

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

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

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

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

hasGridMode

• hasGridMode: boolean = false

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:472

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

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

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

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

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

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

isNextPageRequested

• isNextPageRequested: boolean = false

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:470

isPreviousPageRequested

• isPreviousPageRequested: boolean = false

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:471

isShiftDown

• isShiftDown: boolean = false

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:478

items

• items: Item[]

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:453

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

lastSortedColumn

• lastSortedColumn: Column

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:455

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

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

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

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

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

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

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

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

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

resultMode

• resultMode: ModeEnum

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:473

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

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

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

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

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

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

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

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

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

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

tbodyHeight

• tbodyHeight: number = null

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:459

theadHeight

• theadHeight: number = null

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:460

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

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

translate

• translate: TranslateService

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:486

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

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

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

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

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

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

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

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

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

ngAfterViewInit

▸ ngAfterViewInit(): void

Returns

void

Implementation of

AfterViewInit.ngAfterViewInit

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:523

ngDoCheck

▸ ngDoCheck(): void

Returns

void

Implementation of

DoCheck.ngDoCheck

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:607

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

ngOnInit

▸ ngOnInit(): void

Returns

void

Implementation of

OnInit.ngOnInit

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:512

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

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

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

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

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

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

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

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

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

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

setGeoSortAction

▸ setGeoSortAction(): void

Returns

void

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:682

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

setItemActions

▸ setItemActions(item): void

Description

set the list of actions of an item

Parameters

Name Type
item Item

Returns

void

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:920

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

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

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

shiftDown

▸ shiftDown(_): void

Parameters

Name Type
_ any

Returns

void

Defined in

projects/arlas-components/src/lib/components/results/result-list/result-list.component.ts:502

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

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

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

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