arlas-web-contributors / SwimLaneContributor

Class: SwimLaneContributor

Extends

Contributor

Constructors

new SwimLaneContributor()

new SwimLaneContributor(identifier, collaborativeSearcheService, configService, collection, isOneDimension?): SwimLaneContributor

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

isOneDimension?

boolean

Returns

SwimLaneContributor

Overrides

Contributor.constructor

Defined in

src/contributors/SwimLaneContributor.ts:113

Properties

aggregations

aggregations: Aggregation[]

List of aggregation models used to fetch data

Defined in

src/contributors/SwimLaneContributor.ts:88

cacheDuration

protected cacheDuration: 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

json_path

json_path: string

Json path to explore element aggregation, count by default

Defined in

src/contributors/SwimLaneContributor.ts:92

linkedContributorId

linkedContributorId: string

Inherited from

Contributor.linkedContributorId

Defined in

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

range

range: ComputationResponse

The range of data that this contributor fetches.

Defined in

src/contributors/SwimLaneContributor.ts:83

selectedSwimlanes

selectedSwimlanes: Set\<string>

selectedSwimlanes is the list of selected terms (lanes) in the swimlane.

Defined in

src/contributors/SwimLaneContributor.ts:78

swimData

swimData: SwimlaneData

Swimlane data has - lanes: a map of - The keys represent the lanes keywords. - The value of a lane is a histogram represented as an array. - stats: stats summerizing the swimlane data

Defined in

src/contributors/SwimLaneContributor.ts:73

useUtc

useUtc: any

Wether use UTC for display time

Defined in

src/contributors/SwimLaneContributor.ts:100

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(aggResponse): SwimlaneData

Parameters

aggResponse

AggregationResponse

Returns

SwimlaneData

Overrides

Contributor.computeData

Defined in

src/contributors/SwimLaneContributor.ts:201

fetchData()

fetchData(collaborationEvent): Observable\<AggregationResponse>

Parameters

collaborationEvent

CollaborationEvent

Returns

Observable\<AggregationResponse>

Overrides

Contributor.fetchData

Defined in

src/contributors/SwimLaneContributor.ts:167

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

name and live informations about filter contributor.

Overrides

Contributor.getFilterDisplayName

Defined in

src/contributors/SwimLaneContributor.ts:277

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 of contributor used in configuration.

Overrides

Contributor.getPackageName

Defined in

src/contributors/SwimLaneContributor.ts:273

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/SwimLaneContributor.ts:133

setData()

setData(data): SwimlaneData

Parameters

data

SwimlaneData

Returns

SwimlaneData

Overrides

Contributor.setData

Defined in

src/contributors/SwimLaneContributor.ts:244

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

SwimlaneData

collaboration

Collaboration

Returns

any

Overrides

Contributor.setSelection

Defined in

src/contributors/SwimLaneContributor.ts:249

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

valueChanged()

valueChanged(selectedSwimlanes): void

Set filter on value change, used in output of component

Parameters

selectedSwimlanes

Set\<string>

List of selected lanes of the swimlane

Returns

void

Defined in

src/contributors/SwimLaneContributor.ts:141

getJsonSchema()

static getJsonSchema(): Object

Returns

Object

Defined in

src/contributors/SwimLaneContributor.ts:129