Skip to content

arlas-web-contributors > "contributors/SwimLaneContributor" > SwimLaneContributor

Class: SwimLaneContributor

Hierarchy

Contributor

↳ SwimLaneContributor

Index

Constructors

Properties

Methods


Constructors

constructor

new SwimLaneContributor(identifier: string, collaborativeSearcheService: CollaborativesearchService, configService: ConfigService, isOneDimension?: boolean): SwimLaneContributor

Overrides Contributor.__constructor

Defined in contributors/SwimLaneContributor.ts:78

Build a new contributor.

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.
Optional isOneDimension boolean

Returns: SwimLaneContributor


Properties

aggregations

● aggregations: Aggregation[] = this.getConfigValue('swimlanes')[0]['aggregationmodels']

Defined in contributors/SwimLaneContributor.ts:59

List of aggregation models used to fetch data


collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Inherited from Contributor.collaborativeSearcheService

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


configService

● configService: ConfigService

Inherited from Contributor.configService

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


identifier

● identifier: string

Inherited from Contributor.identifier

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


json_path

● json_path: string

Defined in contributors/SwimLaneContributor.ts:74

Json path to explore element aggregation, count by default


range

● range: RangeResponse

Defined in contributors/SwimLaneContributor.ts:54

The range of data that this contributor fetches.


selectedSwimlanes

● selectedSwimlanes: Set<string>

Defined in contributors/SwimLaneContributor.ts:49

selectedSwimlanes is the list of selected terms in the swimlane.


swimData

● swimData: Map<string, Array<object>> = new Map>()

Defined in contributors/SwimLaneContributor.ts:44

New data need to be draw in the swimlane (could be set to input(): data of Swimlane Component


termField

● termField: string = this.getConfigValue('swimlanes')[0]['termField']

Defined in contributors/SwimLaneContributor.ts:69

The term field that separates the swimlane to lanes.


xAxisField

● xAxisField: string = this.getConfigValue('swimlanes')[0]['xAxisField']

Defined in contributors/SwimLaneContributor.ts:64

Numeric/temporal field represented on the x axis of the swimlane.


Methods

computeData

computeData(aggResponse: AggregationResponse): Map<string, Array<object>>

Overrides Contributor.computeData

Defined in contributors/SwimLaneContributor.ts:161

Parameters:

Name Type
aggResponse AggregationResponse

Returns: Map<string, Array<object>>


fetchData

fetchData(collaborationEvent: CollaborationEvent): Observable<AggregationResponse>

Overrides Contributor.fetchData

Defined in contributors/SwimLaneContributor.ts:130

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

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

Returns: string


getName

getName(): string

Inherited from Contributor.getName

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

Returns: string name of contributor set in configuration.


getPackageName

getPackageName(): string

Overrides Contributor.getPackageName

Defined in contributors/SwimLaneContributor.ts:205

Returns: string


setData

setData(data: any): Map<string, Array<object>>

Overrides Contributor.setData

Defined in contributors/SwimLaneContributor.ts:179

Parameters:

Name Type
data any

Returns: Map<string, Array<object>>


setSelection

setSelection(data: Map<string, Array<object>>, collaboration: Collaboration): any

Overrides Contributor.setSelection

Defined in contributors/SwimLaneContributor.ts:184

Parameters:

Name Type
data Map<string, Array<object>>
collaboration Collaboration

Returns: any


valueChanged

valueChanged(selectedSwimlanes: Set<string>): void

Defined in contributors/SwimLaneContributor.ts:106

Set filter on value change, use in output of component

Parameters:

Name Type
selectedSwimlanes Set<string>

Returns: void


<Static> getJsonSchema

getJsonSchema(): Object

Defined in contributors/SwimLaneContributor.ts:98

Returns: Object