arlas-web-contributors / HistogramContributor

Class: HistogramContributor

This contributor works with the Angular HistogramComponent of the Arlas-web-components project. 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

Extended by

DetailedHistogramContributor

Constructors

new HistogramContributor()

new HistogramContributor(identifier, collaborativeSearcheService, configService, collection, isOneDimension?, additionalCollections?): HistogramContributor

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

additionalCollections?

object[]

Returns

HistogramContributor

Overrides

Contributor.constructor

Defined in

src/contributors/HistogramContributor.ts:131

Properties

additionalCollections?

optional additionalCollections: object[]

collectionName

collectionName: string

field

field: string

Defined in

src/contributors/HistogramContributor.ts:135

aggregations

protected aggregations: Aggregation[]

ARLAS Server Aggregation used to draw the chart, define in configuration

Defined in

src/contributors/HistogramContributor.ts:87

cacheDuration

protected cacheDuration: number

Inherited from

Contributor.cacheDuration

Defined in

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

chartData

chartData: object[]

New data need to be draw on the histogram (could be set to @Input() data of HistogramComponent

chartId?

optional chartId: string

key

key: number

value

value: number

Defined in

src/contributors/HistogramContributor.ts:50

chartDataEvent

chartDataEvent: Subject\<object[]>

Defined in

src/contributors/HistogramContributor.ts:53

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

detailedHistrogramContributor

detailedHistrogramContributor: DetailedHistogramContributor

Defined in

src/contributors/HistogramContributor.ts:124

endCollaborationEvent

endCollaborationEvent: Subject\<CollaborationEvent>

Inherited from

Contributor.endCollaborationEvent

Defined in

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

endValue

protected endValue: string

End value of selection use to the display of filterDisplayName

Defined in

src/contributors/HistogramContributor.ts:107

field

protected field: string

ARLAS Server field of aggregation used to draw the chart, retrieve from Aggregation

Defined in

src/contributors/HistogramContributor.ts:99

identifier

identifier: string

Inherited from

Contributor.identifier

Defined in

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

intervalListSelection

intervalListSelection: SelectedOutputValues[] = []

New selections need to be draw on the histogram (could be set to @Input() intervalSelection of HistogramComponent

Defined in

src/contributors/HistogramContributor.ts:63

intervalSelection

intervalSelection: SelectedOutputValues

New selection current need to be draw on the histogram (could be set to @Input() intervalSelection of HistogramComponent

Defined in

src/contributors/HistogramContributor.ts:58

isDataUpdating

isDataUpdating: boolean

Inherited from

Contributor.isDataUpdating

Defined in

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

isOneDimension?

protected optional isOneDimension: boolean

Defined in

src/contributors/HistogramContributor.ts:134

json_path

protected json_path: string

Json path to explore element aggregation, count by default

Defined in

src/contributors/HistogramContributor.ts:91

linkedContributorId

linkedContributorId: string

Inherited from

Contributor.linkedContributorId

Defined in

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

maxBuckets

maxBuckets: number = 200

to be set in the toolkit when creating the contributor

Defined in

src/contributors/HistogramContributor.ts:122

maxValue

protected maxValue: number = 0

Max value of all bucketn use for oneDimension histogram palette

Defined in

src/contributors/HistogramContributor.ts:111

nbBuckets

protected nbBuckets: number

Number of buckets in the histogram. If not specified, the interval in the aggregagtion model is used instead.

Defined in

src/contributors/HistogramContributor.ts:95

range

range: number

Histogram's range

Defined in

src/contributors/HistogramContributor.ts:83

startValue

protected startValue: string

Start value of selection use to the display of filterDisplayName

Defined in

src/contributors/HistogramContributor.ts:103

timeLabel

timeLabel: any

Labels of the timelines

Defined in

src/contributors/HistogramContributor.ts:115

timeShortcuts

timeShortcuts: StringifiedTimeShortcut[]

List of all the predefined time shortcuts

Defined in

src/contributors/HistogramContributor.ts:68

timeShortcutsLabels

timeShortcutsLabels: string[]

List of shortcuts labels to fetch from the predefined time shortcuts list

Defined in

src/contributors/HistogramContributor.ts:73

useUtc

useUtc: any

Wether use UTC for display time

Defined in

src/contributors/HistogramContributor.ts:119

yearShortcutsLabels

yearShortcutsLabels: string[]

List of years shortcuts labels

Defined in

src/contributors/HistogramContributor.ts:78

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(aggResponses): object[]

Parameters

aggResponses

AggregationResponse[]

Returns

object[]

Overrides

Contributor.computeData

Defined in

src/contributors/HistogramContributor.ts:304

fetchData()

fetchData(collaborationEvent?): Observable\<AggregationResponse[]>

Parameters

collaborationEvent?

CollaborationEvent

Returns

Observable\<AggregationResponse[]>

Overrides

Contributor.fetchData

Defined in

src/contributors/HistogramContributor.ts:287

fetchDataGivenFilter()

protected fetchDataGivenFilter(identifier, additionalFilters?): Observable\<AggregationResponse[]>

Parameters

identifier

string

additionalFilters?

Map\<string, Filter>

Returns

Observable\<AggregationResponse[]>

Defined in

src/contributors/HistogramContributor.ts:349

getAggregations()

getAggregations(): Aggregation[]

Returns

Aggregation[]

Defined in

src/contributors/HistogramContributor.ts:181

getAllCollections()

getAllCollections(): object[]

Returns

object[]

Defined in

src/contributors/HistogramContributor.ts:297

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

getField()

getField(): string

Returns

string

Defined in

src/contributors/HistogramContributor.ts:169

getFilterDisplayName()

getFilterDisplayName(): string

Returns

string

Pretty name of contribution based on startValue/endValue properties

Overrides

Contributor.getFilterDisplayName

Defined in

src/contributors/HistogramContributor.ts:218

getJsonPath()

getJsonPath(): string

Returns

string

Defined in

src/contributors/HistogramContributor.ts:177

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

getNbBuckets()

getNbBuckets(): number

Returns

number

Defined in

src/contributors/HistogramContributor.ts:161

getPackageName()

getPackageName(): string

Returns

string

Package name for the configuration service.

Overrides

Contributor.getPackageName

Defined in

src/contributors/HistogramContributor.ts:234

getShortcutLabel()

getShortcutLabel(intervalSelection, startValue, endValue): string

Parameters

intervalSelection

SelectedOutputValues

startValue

string

endValue

string

Returns

string

Defined in

src/contributors/HistogramContributor.ts:268

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/HistogramContributor.ts:157

resolveHistogramAgg()

protected resolveHistogramAgg(identifier, aggregations, collaborations, additionalFilter, ac): Observable\<AggregationResponse>

Parameters

identifier

string

aggregations

Aggregation[]

collaborations

Map\<string, Collaboration>

additionalFilter

Filter

ac

CollectionAggField

Returns

Observable\<AggregationResponse>

Defined in

src/contributors/HistogramContributor.ts:403

setAggregations()

setAggregations(aggregations): void

Parameters

aggregations

Aggregation[]

Returns

void

Defined in

src/contributors/HistogramContributor.ts:207

setData()

setData(data): object[]

Parameters

data

object[]

Returns

object[]

Overrides

Contributor.setData

Defined in

src/contributors/HistogramContributor.ts:321

setField()

setField(field): void

Parameters

field

any

Returns

void

Defined in

src/contributors/HistogramContributor.ts:173

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

setNbBuckets()

setNbBuckets(nbBuckets): void

Parameters

nbBuckets

number

Returns

void

Defined in

src/contributors/HistogramContributor.ts:165

setSelection()

setSelection(data, collaboration): any

Parameters

data

object[]

collaboration

Collaboration

Returns

any

Overrides

Contributor.setSelection

Defined in

src/contributors/HistogramContributor.ts:339

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(values, collections?): void

Triggers the collaboration of this contributor on the given intervals and for the given collections

Parameters

values

SelectedOutputValues[]

List of selected intervals in the histogram

collections?

CollectionAggField[]

List of collections to declare in the collaboration. This list should be a subset of collections declared in this contributor.

Returns

void

Defined in

src/contributors/HistogramContributor.ts:244

getJsonSchema()

static getJsonSchema(): Object

Returns

Object

Defined in

src/contributors/HistogramContributor.ts:211