arlas-web-contributors / ChipsSearchContributor
Class: ~~ChipsSearchContributor~~
Deprecated
This class should not be used, use SearchContributor
Extends
Contributor
Constructors
new ChipsSearchContributor()
new ChipsSearchContributor(
identifier,collaborativeSearcheService,configService,collection):ChipsSearchContributor
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
Overrides
Contributor.constructor
Defined in
src/contributors/ChipsSearchContributor.ts:79
Properties
~~autocomplete_field~~
autocomplete_field:
string
Keyword field on which the autocompletion is performed
Defined in
src/contributors/ChipsSearchContributor.ts:54
~~autocomplete_size~~
autocomplete_size:
number
Number of suggested keywords by the autocompletion
Defined in
src/contributors/ChipsSearchContributor.ts:59
~~cacheDuration~~
protectedcacheDuration:number
Inherited from
Contributor.cacheDuration
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:18
~~chipMapData~~
chipMapData:
Map\<string,number>
Map of string/number, label/count of all chips, use in input of component
Defined in
src/contributors/ChipsSearchContributor.ts:68
~~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/ChipsSearchContributor.ts:70
~~linkedContributorId~~
linkedContributorId:
string
Inherited from
Contributor.linkedContributorId
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:17
~~query~~
query:
string
Global query based on all concatenate chips word
Defined in
src/contributors/ChipsSearchContributor.ts:64
~~search_field~~
search_field:
string
Keyword field on which the full text search is applied
Defined in
src/contributors/ChipsSearchContributor.ts:49
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
~~activateLastBackspace()~~
activateLastBackspace(
lastBackspace):void
Subscribe to the sizeOnSearchBackspaceBus to remove last chip on backspace keyup
Parameters
lastBackspace
Subject\<boolean>
Returns
void
Defined in
src/contributors/ChipsSearchContributor.ts:219
~~addWord()~~
addWord(
value):void
Add a new chip with value and count, set filter.
Parameters
value
string
Label of the chip.
Returns
void
Defined in
src/contributors/ChipsSearchContributor.ts:183
~~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/ChipsSearchContributor.ts:150
~~fetchData()~~
fetchData(
collaborationEvent):Observable\<{hits:Hits;label:string; }>
Parameters
collaborationEvent
CollaborationEvent
Returns
Observable\<{ hits: Hits; label: string; }>
Overrides
Contributor.fetchData
Defined in
src/contributors/ChipsSearchContributor.ts:100
~~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 based on query propoerty.
Overrides
Contributor.getFilterDisplayName
Defined in
src/contributors/ChipsSearchContributor.ts:170
~~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/ChipsSearchContributor.ts:176
~~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/ChipsSearchContributor.ts:96
~~removeWord()~~
removeWord(
word):void
Remove a chip , set filter.
Parameters
word
string
Returns
void
Defined in
src/contributors/ChipsSearchContributor.ts:209
~~setData()~~
setData(
data):any
Parameters
data
hits
Hits
label
string
Returns
any
Overrides
Contributor.setData
Defined in
src/contributors/ChipsSearchContributor.ts:153
~~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/ChipsSearchContributor.ts:163
~~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()~~
staticgetJsonSchema():Object
Returns
Object
Defined in
src/contributors/ChipsSearchContributor.ts:92