arlas-web-contributors / AnalyticsContributor
Class: AnalyticsContributor
This contributor works with the Angular Analytic board of the Arlas-web-components project. This contributor send data to hide/show panel in Analytic board. This class make the brigde between the component which displays the data and the collaborativeSearchService of the Arlas-web-core which retrieve the data from the server.
Extends
Contributor
Constructors
new AnalyticsContributor()
new AnalyticsContributor(
identifier,collaborativeSearcheService,configService,collection,groupIdToValues):AnalyticsContributor
Build a new contributor.
Parameters
identifier
string
Identifier of the contributor.
collaborativeSearcheService
CollaborativesearchService
Instance of CollaborativesearchService from Arlas-web-core.
configService
ConfigService
Instance of ConfigService from Arlas-web-core.
collection
string
groupIdToValues
Map\<string, string[]>
Returns
Overrides
Contributor.constructor
Defined in
src/contributors/AnalyticsContributor.ts:59
Properties
analitycsIdtoShow
analitycsIdtoShow:
Map\<string,boolean>
Map of string,boolean retrieved from Server response and to be returned for the component as input @Input() inputData
Defined in
src/contributors/AnalyticsContributor.ts:41
cacheDuration
protectedcacheDuration: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
linkedContributorId
linkedContributorId:
string
Inherited from
Contributor.linkedContributorId
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:17
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(
aggregationResonse):Map\<string,number>
Parameters
aggregationResonse
AggregationResponse
Returns
Map\<string, number>
Overrides
Contributor.computeData
Defined in
src/contributors/AnalyticsContributor.ts:106
fetchData()
fetchData(
collaborationEvent):Observable\<AggregationResponse>
Parameters
collaborationEvent
CollaborationEvent
Returns
Observable\<AggregationResponse>
Overrides
Contributor.fetchData
Defined in
src/contributors/AnalyticsContributor.ts:94
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 contribution based on selected bar
Overrides
Contributor.getFilterDisplayName
Defined in
src/contributors/AnalyticsContributor.ts:80
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/AnalyticsContributor.ts:86
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/AnalyticsContributor.ts:90
setData()
setData(
data):Map\<string,number>
Parameters
data
Map\<string, number>
Returns
Map\<string, number>
Overrides
Contributor.setData
Defined in
src/contributors/AnalyticsContributor.ts:117
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(
data,collaboration):any
Parameters
data
[string, number][]
collaboration
Collaboration
Returns
any
Overrides
Contributor.setSelection
Defined in
src/contributors/AnalyticsContributor.ts:130
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/AnalyticsContributor.ts:73