arlas-web-contributors > "contributors/ChipsSearchContributor" > ChipsSearchContributor

Class: ChipsSearchContributor

Hierarchy

Contributor

↳ ChipsSearchContributor

Index

Constructors

Properties

Methods

Constructors

constructor

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

Overrides Contributor.__constructor

Defined in contributors/ChipsSearchContributor.ts:67

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

Properties

autocomplete_field

● autocomplete_field: string = this.getConfigValue('autocomplete_field')

Defined in contributors/ChipsSearchContributor.ts:51

autocomplete_size

● autocomplete_size: number = this.getAutocompleteSize()

Defined in contributors/ChipsSearchContributor.ts:56

<Protected> cacheDuration

● cacheDuration: number

Inherited from Contributor.cacheDuration

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

chipMapData

● chipMapData: Map<string, number> = new Map()

Defined in contributors/ChipsSearchContributor.ts:65

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

endCollaborationEvent

● endCollaborationEvent: Subject<unknown>

Inherited from Contributor.endCollaborationEvent

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

identifier

● identifier: string

Inherited from Contributor.identifier

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

isDataUpdating

● isDataUpdating: boolean

Inherited from Contributor.isDataUpdating

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

lastBackspaceBus

● lastBackspaceBus: Subject<boolean>

Defined in contributors/ChipsSearchContributor.ts:67

query

● query: string

Defined in contributors/ChipsSearchContributor.ts:61

search_field

● search_field: string = this.getConfigValue('search_field')

Defined in contributors/ChipsSearchContributor.ts:46

updateData

● updateData: boolean

Inherited from Contributor.updateData

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

Methods

activateLastBackspace

▸ activateLastBackspace(lastBackspace: Subject<boolean>): void

Defined in contributors/ChipsSearchContributor.ts:214

Parameters:

Name Type
lastBackspace Subject<boolean>

Returns: void

addWord

▸ addWord(value: string): void

Defined in contributors/ChipsSearchContributor.ts:178

Parameters:

Name Type Description
value string Label of the chip.

Returns: void

computeData

▸ computeData(data: object): object

Overrides Contributor.computeData

Defined in contributors/ChipsSearchContributor.ts:145

Parameters:

data: object

Name Type
hits Hits
label string

Returns: object

fetchData

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

Overrides Contributor.fetchData

Defined in contributors/ChipsSearchContributor.ts:93

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: Observable<object>

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/ChipsSearchContributor.ts:165

Returns: string Pretty name of contributor based on query propoerty.

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/ChipsSearchContributor.ts:171

Returns: string Package name for the configuration service.

removeWord

▸ removeWord(word: string): void

Defined in contributors/ChipsSearchContributor.ts:204

Parameters:

Name Type
word string

Returns: void

setData

▸ setData(data: object): any

Overrides Contributor.setData

Defined in contributors/ChipsSearchContributor.ts:148

Parameters:

data: object

Name Type
hits Hits
label string

Returns: any

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(collaboration: Collaboration): any

Overrides Contributor.setSelection

Defined in contributors/ChipsSearchContributor.ts:158

Parameters:

Name Type
collaboration Collaboration

Returns: any

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/ChipsSearchContributor.ts:89

Returns: Object