Skip to content

arlas-web-contributors

arlas-web-contributors / SearchContributor

Class: SearchContributor

Extends

  • Contributor

Constructors

new SearchContributor()

new SearchContributor(identifier, collaborativeSearcheService, configService, collection): SearchContributor

Build a new contributor.

Parameters

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

SearchContributor

Overrides

Contributor.constructor

Defined in

src/contributors/SearchContributor.ts:63

Properties

autoCompleteField

autoCompleteField: string

Keyword field on which the autocompletion is performed

Defined in

src/contributors/SearchContributor.ts:43

autoCompleteSize

autoCompleteSize: number

Number of suggested keywords by the autocompletion

Defined in

src/contributors/SearchContributor.ts:48

cacheDuration

protected cacheDuration: number

Inherited from

Contributor.cacheDuration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:18

collaborativeSearcheService

collaborativeSearcheService: CollaborativesearchService

Inherited from

Contributor.collaborativeSearcheService

Defined in

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

collection

collection: string

Inherited from

Contributor.collection

Defined in

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

collections

collections: CollectionAggField[]

Inherited from

Contributor.collections

Defined in

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

configService

configService: ConfigService

Inherited from

Contributor.configService

Defined in

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

endCollaborationEvent

endCollaborationEvent: Subject\<CollaborationEvent>

Inherited from

Contributor.endCollaborationEvent

Defined in

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

identifier

identifier: string

Inherited from

Contributor.identifier

Defined in

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

isDataUpdating

isDataUpdating: boolean

Inherited from

Contributor.isDataUpdating

Defined in

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

lastBackspaceBus

lastBackspaceBus: Subject\<boolean>

Defined in

src/contributors/SearchContributor.ts:50

linkedContributorId

linkedContributorId: string

Inherited from

Contributor.linkedContributorId

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:17

searchField

searchField: string

Keyword field on which the full text search is applied

Defined in

src/contributors/SearchContributor.ts:38

searching

searching: boolean = false

Defined in

src/contributors/SearchContributor.ts:52

Accessors

updateData

Get Signature

get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Set Signature

set updateData(value): void

Parameters
value

boolean

set if the data of contributor should be updated or not.

Returns

void

Inherited from

Contributor.updateData

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:49

Methods

computeData()

computeData(data): object

Parameters

data
hits

Hits

label

string

Returns

object

hits

hits: Hits

label

label: string

Overrides

Contributor.computeData

Defined in

src/contributors/SearchContributor.ts:88

fetchData()

fetchData(collaborationEvent): Observable\<[]>

Parameters

collaborationEvent

CollaborationEvent

Returns

Observable\<[]>

Overrides

Contributor.fetchData

Defined in

src/contributors/SearchContributor.ts:84

getAutoCompleteResponse$()

getAutoCompleteResponse$(search): Observable\<AggregationResponse>

Parameters

string

Returns

Observable\<AggregationResponse>

Defined in

src/contributors/SearchContributor.ts:112

getConfigValue()

getConfigValue(key): any

Parameters

key

string

a key defined in configuration.

Returns

any

value of the key in configuration.

Inherited from

Contributor.getConfigValue

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:34

getFilterDisplayName()

getFilterDisplayName(): string

Returns

string

Pretty name of contributor.

Overrides

Contributor.getFilterDisplayName

Defined in

src/contributors/SearchContributor.ts:102

getName()

getName(): string

Returns

string

name of contributor set in configuration.

Inherited from

Contributor.getName

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:41

getPackageName()

getPackageName(): string

Returns

string

Package name for the configuration service.

Overrides

Contributor.getPackageName

Defined in

src/contributors/SearchContributor.ts:108

isMyLinkedContributorCollaboration()

isMyLinkedContributorCollaboration(collaborationEvent): boolean

Parameters

collaborationEvent

CollaborationEvent

Returns

boolean

Inherited from

Contributor.isMyLinkedContributorCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:37

isMyOwnCollaboration()

isMyOwnCollaboration(collaborationEvent): boolean

Parameters

collaborationEvent

CollaborationEvent

Returns

boolean

Inherited from

Contributor.isMyOwnCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:36

isUpdateEnabledOnOwnCollaboration()

isUpdateEnabledOnOwnCollaboration(): boolean

Returns

boolean

Overrides

Contributor.isUpdateEnabledOnOwnCollaboration

Defined in

src/contributors/SearchContributor.ts:80

search()

search(value): void

Parameters

value

string

Returns

void

Defined in

src/contributors/SearchContributor.ts:140

setData()

setData(data): any

Parameters

data
hits

Hits

label

string

Returns

any

Overrides

Contributor.setData

Defined in

src/contributors/SearchContributor.ts:91

setName()

setName(name): void

Parameters

name

string

Returns

void

set the name of the contributor

Inherited from

Contributor.setName

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:45

setSelection()

setSelection(collaboration): any

Parameters

collaboration

Collaboration

Returns

any

Overrides

Contributor.setSelection

Defined in

src/contributors/SearchContributor.ts:95

updateFromCollaboration()

updateFromCollaboration(collaborationEvent): void

Parameters

collaborationEvent

CollaborationEvent

Returns

void

Inherited from

Contributor.updateFromCollaboration

Defined in

node_modules/arlas-web-core/models/contributor.d.ts:62

getJsonSchema()

static getJsonSchema(): Object

Returns

Object

Defined in

src/contributors/SearchContributor.ts:76