arlas-web-contributors > "contributors/SwimLaneContributor" > SwimLaneContributor
Class: SwimLaneContributor
Hierarchy
Contributor
↳ SwimLaneContributor
Index
Constructors
Properties
- aggregations
- cacheDuration
- collaborativeSearcheService
- collection
- collections
- configService
- endCollaborationEvent
- identifier
- isDataUpdating
- json_path
- range
- selectedSwimlanes
- swimData
- updateData
- useUtc
Methods
- computeData
- fetchData
- getConfigValue
- getFilterDisplayName
- getName
- getPackageName
- setData
- setName
- setSelection
- updateFromCollaboration
- valueChanged
- getJsonSchema
Constructors
constructor
⊕ new SwimLaneContributor(identifier: string
, collaborativeSearcheService: CollaborativesearchService
, configService: ConfigService
, collection: string
, isOneDimension?: boolean
): SwimLaneContributor
Overrides Contributor.__constructor
Defined in contributors/SwimLaneContributor.ts:103
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 |
|
Optional isOneDimension |
boolean |
Returns: SwimLaneContributor
Properties
aggregations
● aggregations: Aggregation
[] = this.getSwimlaneAggregations()
Defined in contributors/SwimLaneContributor.ts:88
<Protected>
cacheDuration
● cacheDuration: number
Inherited from Contributor.cacheDuration
Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:17
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
json_path
● json_path: string
Defined in contributors/SwimLaneContributor.ts:92
range
● range: ComputationResponse
Defined in contributors/SwimLaneContributor.ts:83
selectedSwimlanes
● selectedSwimlanes: Set
<string
>
Defined in contributors/SwimLaneContributor.ts:78
swimData
● swimData: SwimlaneData
Defined in contributors/SwimLaneContributor.ts:73
updateData
● updateData: boolean
Inherited from Contributor.updateData
Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:46
useUtc
● useUtc: any
= this.getConfigValue('useUtc') !== undefined ? this.getConfigValue('useUtc') : true
Defined in contributors/SwimLaneContributor.ts:100
Methods
computeData
▸ computeData(aggResponse: AggregationResponse
): SwimlaneData
Overrides Contributor.computeData
Defined in contributors/SwimLaneContributor.ts:193
Parameters:
Name | Type |
---|---|
aggResponse | AggregationResponse |
Returns: SwimlaneData
fetchData
▸ fetchData(collaborationEvent: CollaborationEvent
): Observable
<AggregationResponse
>
Overrides Contributor.fetchData
Defined in contributors/SwimLaneContributor.ts:161
Parameters:
Name | Type |
---|---|
collaborationEvent | CollaborationEvent |
Returns: Observable
<AggregationResponse
>
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/SwimLaneContributor.ts:269
Returns: string
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/SwimLaneContributor.ts:265
Returns: string
setData
▸ setData(data: SwimlaneData): SwimlaneData
Overrides Contributor.setData
Defined in contributors/SwimLaneContributor.ts:236
Parameters:
Name | Type |
---|---|
data | SwimlaneData |
Returns: SwimlaneData
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(data: SwimlaneData, collaboration: Collaboration
): any
Overrides Contributor.setSelection
Defined in contributors/SwimLaneContributor.ts:241
Parameters:
Name | Type |
---|---|
data | SwimlaneData |
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
valueChanged
▸ valueChanged(selectedSwimlanes: Set
<string
>): void
Defined in contributors/SwimLaneContributor.ts:135
Parameters:
Name | Type | Description |
---|---|---|
selectedSwimlanes | Set <string > |
List of selected lanes of the swimlane |
Returns: void
<Static>
getJsonSchema
▸ getJsonSchema(): Object
Defined in contributors/SwimLaneContributor.ts:127
Returns: Object