Skip to content

arlas-web-contributors > "contributors/ResultListContributor" > ResultListContributor

Class: ResultListContributor

This contributor works with the Angular ResultListComponent of the Arlas-web-components project. This class make the brigde between the component which displays the data and the collaborativeSearchService of the Arlas-web-core which retrieve the data from the server.

Hierarchy

Contributor

↳ ResultListContributor

Index

Constructors

Properties

Methods


Constructors

constructor

new ResultListContributor(identifier: string, collaborativeSearcheService: CollaborativesearchService, configService: ConfigService): ResultListContributor

Overrides Contributor.__constructor

Defined in contributors/ResultListContributor.ts:198

Build a new contributor.

Parameters:

Name Type Description
identifier string Identifier of contributor.
collaborativeSearcheService CollaborativesearchService Instance of CollaborativesearchService from Arlas-web-core.
configService ConfigService Instance of ConfigService from Arlas-web-core.

Returns: ResultListContributor


Properties

actionToTriggerOnClick

● actionToTriggerOnClick: Array<Action> = []

Defined in contributors/ResultListContributor.ts:178

List of actions, from all the contributors of the app, which we could trigger on click in the ResultListComponent.


collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Inherited from Contributor.collaborativeSearcheService

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:8


configService

● configService: ConfigService

Inherited from Contributor.configService

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:7


data

● data: Array<Map<string, string | number | Date>> = new Array>()

Defined in contributors/ResultListContributor.ts:162

Data to populate result list, @Input() data of ResultListComponent.


detailedDataRetriever

● detailedDataRetriever: ResultListDetailedDataRetriever = new ResultListDetailedDataRetriever()

Defined in contributors/ResultListContributor.ts:174

Instance of DetailedDataRetriever class, @Input() detailedDataRetriever of ResultListComponent.


● dropDownMapValues: Map<string, Observable<Array<string>>> = new Map>>()

Defined in contributors/ResultListContributor.ts:170

List of values to select mapped to each field represented on the resultList. The list of values to select is wrapped in an Observable.


fieldsConfiguration

● fieldsConfiguration: any = this.getConfigValue('fieldsConfiguration')

Defined in contributors/ResultListContributor.ts:186

A configuration object that allows to set id field, title field, fields used in tooltip/icons and urls to images && thumbnails


fieldsList

● fieldsList: Array<object> = []

Defined in contributors/ResultListContributor.ts:166

List of columns of the table, @Input() fieldsList of ResultListComponent.


filtersMap

● filtersMap: Map<string, string | number | Date> = new Map()

Defined in contributors/ResultListContributor.ts:180


identifier

● identifier: string

Inherited from Contributor.identifier

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:6


Methods

addAction

addAction(action: Action): void

Defined in contributors/ResultListContributor.ts:319

Method to add Action in actionToTrigger

Parameters:

Name Type Description
action Action action to add

Returns: void


computeData

computeData(hits: Hits): Array<Map<string, string | number | Date>>

Overrides Contributor.computeData

Defined in contributors/ResultListContributor.ts:471

Parameters:

Name Type
hits Hits

Returns: Array<Map<string, string | number | Date>>


downloadItem

downloadItem(elementidentifier: ElementIdentifier): void

Defined in contributors/ResultListContributor.ts:279

Download item information as json

Parameters:

Name Type
elementidentifier ElementIdentifier

Returns: void


fetchData

fetchData(collaborationEvent: CollaborationEvent): Observable<Hits>

Overrides Contributor.fetchData

Defined in contributors/ResultListContributor.ts:459

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: Observable<Hits>


geoSort

geoSort(lat: number, lng: number): void

Defined in contributors/ResultListContributor.ts:363

Method call when emit the output sortColumnEvent

Parameters:

Name Type
lat number
lng number

Returns: void


getConfigValue

getConfigValue(key: string): any

Inherited from Contributor.getConfigValue

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:24

Parameters:

Name Type Description
key string a `key` defined in configuration.

Returns: any value of the key in configuration.


getFilterDisplayName

getFilterDisplayName(): string

Overrides Contributor.getFilterDisplayName

Defined in contributors/ResultListContributor.ts:306

Returns: string Pretty name of contribution.


getMoreData

getMoreData(startFrom: number): void

Defined in contributors/ResultListContributor.ts:442

Method call when emit the output moreDataEvent

Parameters:

Name Type
startFrom number

Returns: void


getName

getName(): string

Inherited from Contributor.getName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:28

Returns: string name of contributor set in configuration.


getPackageName

getPackageName(): string

Overrides Contributor.getPackageName

Defined in contributors/ResultListContributor.ts:312

Returns: string Package name for the configuration service.


removeAction

removeAction(action: Action): void

Defined in contributors/ResultListContributor.ts:328

Method to remove Action in actionToTrigger

Parameters:

Name Type Description
action Action action to remove

Returns: void


resolveDropDownButNot

resolveDropDownButNot(column: Column): void

Defined in contributors/ResultListContributor.ts:561

Parameters:

Name Type
column Column

Returns: void


setData

setData(listResult: Array<Map<string, string | number | Date>>): Map<string, string | number | Date>[]

Overrides Contributor.setData

Defined in contributors/ResultListContributor.ts:537

Parameters:

Name Type
listResult Array<Map<string, string

Returns: Map<string, string | number | Date>[]


setFilters

setFilters(filterMap: Map<string, string | number | Date>): void

Defined in contributors/ResultListContributor.ts:380

Method call when emit the output setFiltersEvent

Parameters:

Name Type Description
filterMap Map<string, string number

Returns: void


setSelection

setSelection(listResult: Array<Map<string, string | number | Date>>, collaboration: Collaboration): any

Overrides Contributor.setSelection

Defined in contributors/ResultListContributor.ts:542

Parameters:

Name Type
listResult Array<Map<string, string
collaboration Collaboration

Returns: any


sortColumn

sortColumn(sortOutput: object): void

Defined in contributors/ResultListContributor.ts:338

Method call when emit the output sortColumnEvent

Parameters:

sortOutput: object

Name Type
fieldName string
sortDirection SortEnum

Returns: void


<Static> getJsonSchema

getJsonSchema(): Object

Defined in contributors/ResultListContributor.ts:272

Returns: Object