arlas-web-core / Exports / Contributor

Class: Contributor

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Contributor(identifier, configService, collaborativeSearcheService, collection?)

Parameters

Name Type Description
identifier string string identifier of the contributor.
configService ConfigService configService of the contributor.
collaborativeSearcheService CollaborativesearchService -
collection? string -

Defined in

models/contributor.ts:43

Properties

cacheDuration

Protected cacheDuration: number

Defined in

models/contributor.ts:36


collaborativeSearcheService

collaborativeSearcheService: CollaborativesearchService


collection

collection: string

Defined in

models/contributor.ts:33


collections

collections: CollectionAggField[]

Defined in

models/contributor.ts:34


configService

configService: ConfigService


endCollaborationEvent

endCollaborationEvent: Subject<unknown>

Defined in

models/contributor.ts:35


identifier

identifier: string


isDataUpdating

isDataUpdating: boolean = false

Defined in

models/contributor.ts:32

Accessors

updateData

get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Defined in

models/contributor.ts:115

set updateData(value): void

Parameters

Name Type Description
value boolean set if the data of contributor should be updated or not.

Returns

void

whether the data of contributor should be updated.

Defined in

models/contributor.ts:122

Methods

computeData

Abstract computeData(data): any

Parameters

Name Type
data any

Returns

any

Defined in

models/contributor.ts:134


fetchData

Abstract fetchData(collaborationEvent): Observable<any>

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

Observable<any>

Defined in

models/contributor.ts:132


getConfigValue

getConfigValue(key): any

Parameters

Name Type Description
key string a key defined in configuration.

Returns

any

value of the key in configuration.

Defined in

models/contributor.ts:87


getFilterDisplayName

Abstract getFilterDisplayName(): string

Returns

string

name and live informations about filter contributor.

Defined in

models/contributor.ts:130


getName

getName(): string

Returns

string

name of contributor set in configuration.

Defined in

models/contributor.ts:101


getPackageName

Abstract getPackageName(): string

Returns

string

package name of contributor used in configuration.

Defined in

models/contributor.ts:81


setData

Abstract setData(data): any

Parameters

Name Type
data any

Returns

any

Defined in

models/contributor.ts:136


setName

setName(name): void

Parameters

Name Type
name string

Returns

void

set the name of the contributor

Defined in

models/contributor.ts:108


setSelection

Abstract setSelection(data, c): any

Parameters

Name Type
data any
c Collaboration

Returns

any

Defined in

models/contributor.ts:138


updateFromCollaboration

updateFromCollaboration(collaborationEvent): void

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

void

Defined in

models/contributor.ts:140