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

Class: ResultListContributor

Hierarchy

Contributor

↳ ResultListContributor

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

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

Overrides Contributor.__constructor

Defined in contributors/ResultListContributor.ts:268

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.
collection string

Returns: ResultListContributor

Properties

actionToTriggerOnClick

● actionToTriggerOnClick: Array<Action> = []

Defined in contributors/ResultListContributor.ts:219

cacheDuration

● cacheDuration: any = this.cacheDuration

Overrides Contributor.cacheDuration

Defined in contributors/ResultListContributor.ts:257

collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Inherited from Contributor.collaborativeSearcheService

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

collection

● collection: string

Inherited from Contributor.collection

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

collections

● collections: CollectionAggField[]

Inherited from Contributor.collections

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

configService

● configService: ConfigService

Inherited from Contributor.configService

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

data

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

Defined in contributors/ResultListContributor.ts:203

detailedDataRetriever

● detailedDataRetriever: ResultListDetailedDataRetriever = new ResultListDetailedDataRetriever()

Defined in contributors/ResultListContributor.ts:215

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

Defined in contributors/ResultListContributor.ts:211

endCollaborationEvent

● endCollaborationEvent: Subject<unknown>

Inherited from Contributor.endCollaborationEvent

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

fieldsConfiguration

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

Defined in contributors/ResultListContributor.ts:226

fieldsList

● fieldsList: Array<object> = []

Defined in contributors/ResultListContributor.ts:207

filter

● filter: object

Defined in contributors/ResultListContributor.ts:247

Type declaration

filtersMap

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

Defined in contributors/ResultListContributor.ts:221

geoOrderSort

● geoOrderSort: string = ""

Defined in contributors/ResultListContributor.ts:255

highlightItems

● highlightItems: Set<any> = new Set()

Defined in contributors/ResultListContributor.ts:259

identifier

● identifier: string

Inherited from Contributor.identifier

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

includeMetadata

● includeMetadata: Array<string> = this.getConfigValue('includeMetadata')

Defined in contributors/ResultListContributor.ts:231

isDataUpdating

● isDataUpdating: boolean

Inherited from Contributor.isDataUpdating

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

maxPages

● maxPages: any = this.getConfigValue('max_pages') ? this.getConfigValue('max_pages') : 3

Defined in contributors/ResultListContributor.ts:239

pageSize

● pageSize: any = this.getConfigValue('search_size') ? this.getConfigValue('search_size') : 100

Defined in contributors/ResultListContributor.ts:235

sort

● sort: string = ""

Defined in contributors/ResultListContributor.ts:251

updateData

● updateData: boolean

Inherited from Contributor.updateData

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

Methods

addAction

▸ addAction(action: Action): void

Defined in contributors/ResultListContributor.ts:395

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

Parameters:

Name Type
hits Hits

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

downloadItem

▸ downloadItem(elementidentifier: ElementIdentifier): void

Defined in contributors/ResultListContributor.ts:354

Parameters:

Name Type
elementidentifier ElementIdentifier

Returns: void

fetchData

▸ fetchData(collaborationEvent: CollaborationEvent): Observable<Hits>

Overrides Contributor.fetchData

Defined in contributors/ResultListContributor.ts:607

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: Observable<Hits>

geoSort

▸ geoSort(lat: number, lng: number, sortById?: boolean): void

Defined in contributors/ResultListContributor.ts:455

Parameters:

Name Type Description
lat number latitude of the geo-point
lng number longitude of the geo-point
Optional sortById boolean whether to add a sort by id to the geosort or not

Returns: void

getConfigValue

▸ getConfigValue(key: string): any

Inherited from Contributor.getConfigValue

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

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

Returns: string Pretty name of contribution.

getMoreData

▸ getMoreData(startFrom: number, sortById?: boolean): void

Defined in contributors/ResultListContributor.ts:543

Parameters:

Name Type Description
startFrom number It corresponds to the number of times this method is being called. It's used to calculate an offset to get the following items
Optional sortById boolean Whether to add a sortById to the cuurent sort/geosort

Returns: void

getName

▸ getName(): string

Inherited from Contributor.getName

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

Returns: string name of contributor set in configuration.

getPackageName

▸ getPackageName(): string

Overrides Contributor.getPackageName

Defined in contributors/ResultListContributor.ts:388

Returns: string Package name for the configuration service.

getPage

▸ getPage(reference: Map<string, string | number | Date>, whichPage: PageEnum): void

Defined in contributors/ResultListContributor.ts:563

Parameters:

Name Type Description
reference Map<string, string number
whichPage PageEnum Whether to fetch next or previous page.

Returns: void

removeAction

▸ removeAction(action: Action): void

Defined in contributors/ResultListContributor.ts:404

Parameters:

Name Type Description
action Action action to remove

Returns: void

resolveDropDownButNot

▸ resolveDropDownButNot(column: Column): void

Defined in contributors/ResultListContributor.ts:721

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

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

Parameters:

Name Type Description
filterMap Map<string, string number

Returns: void

setHighlightItems

▸ setHighlightItems(items: Array<string>): void

Defined in contributors/ResultListContributor.ts:347

Parameters:

Name Type
items Array<string>

Returns: void

setName

▸ setName(name: string): void

Inherited from Contributor.setName

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

Parameters:

Name Type
name string

Returns: void set the name of the contributor

setSelection

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

Overrides Contributor.setSelection

Defined in contributors/ResultListContributor.ts:698

Parameters:

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

Returns: any

sortColumn

▸ sortColumn(sortParams: object, sortById?: boolean): void

Defined in contributors/ResultListContributor.ts:416

Parameters:

sortParams: object

Name Type
fieldName string
sortDirection SortEnum

Optional sortById: boolean

Returns: void

updateFromCollaboration

▸ updateFromCollaboration(collaborationEvent: CollaborationEvent): void

Inherited from Contributor.updateFromCollaboration

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

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: void

<Static> getJsonSchema

▸ getJsonSchema(): Object

Defined in contributors/ResultListContributor.ts:343

Returns: Object

Object literals

fetchState

fetchState: object

Defined in contributors/ResultListContributor.ts:243

endListDown

● endListDown: boolean = false

Defined in contributors/ResultListContributor.ts:243

endListUp

● endListUp: boolean = true

Defined in contributors/ResultListContributor.ts:243