arlas-web-contributors / Exports / DetailedHistogramContributor

Class: DetailedHistogramContributor

This contributor works with the Angular HistogramComponent of the Arlas-web-components project. This contributor is annexed to a main histogram contributor The data returned by this contributor is fetched by applying the last filter of the main contributor in this contributor. The objective is fetching the data around the current selection of the main contributor and plot it in a detailed HistogramComponent. This contibutor doesn't contribute in the collaborativeSearchService. The main contributor does.

Hierarchy

↳ DetailedHistogramContributor

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new DetailedHistogramContributor(identifier, collaborativeSearcheService, configService, collection, isOneDimension?, additionalCollections?)

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.
collection string -
isOneDimension? boolean -
additionalCollections? { collectionName: string ; field: string }[] -

Inherited from

HistogramContributor.constructor

Defined in

src/contributors/HistogramContributor.ts:127

Properties

additionalCollections

• Optional additionalCollections: { collectionName: string ; field: string }[]

Inherited from

HistogramContributor.additionalCollections

aggregations

• Protected aggregations: Aggregation[]

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

Inherited from

HistogramContributor.aggregations

Defined in

src/contributors/HistogramContributor.ts:85

annexedContributorId

• annexedContributorId: any

Id of the histogram contributor which fetches data of the main histogram.

Defined in

src/contributors/DetailedHistogramContributor.ts:41

cacheDuration

• Protected cacheDuration: number

Inherited from

HistogramContributor.cacheDuration

Defined in

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

chartData

• chartData: { chartId?: string ; key: number ; value: number }[]

New data need to be draw on the histogram (could be set to

input() data of HistogramComponent

Inherited from

HistogramContributor.chartData

Defined in

src/contributors/HistogramContributor.ts:48

chartDataEvent

• chartDataEvent: Subject<{ chartId?: string ; key: number ; value: number }[]>

Inherited from

HistogramContributor.chartDataEvent

Defined in

src/contributors/HistogramContributor.ts:51

collaborativeSearcheService

• collaborativeSearcheService: CollaborativesearchService

Inherited from

HistogramContributor.collaborativeSearcheService

Defined in

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

collection

• collection: string

Inherited from

HistogramContributor.collection

Defined in

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

collections

• collections: CollectionAggField[]

Inherited from

HistogramContributor.collections

Defined in

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

configService

• configService: ConfigService

Inherited from

HistogramContributor.configService

Defined in

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

currentSelectedInterval

• currentSelectedInterval: SelectedOutputValues

The current selection on the main histogram

Defined in

src/contributors/DetailedHistogramContributor.ts:51

endCollaborationEvent

• endCollaborationEvent: Subject<unknown>

Inherited from

HistogramContributor.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

Inherited from

HistogramContributor.endValue

Defined in

src/contributors/HistogramContributor.ts:105

field

• Protected field: string

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

Inherited from

HistogramContributor.field

Defined in

src/contributors/HistogramContributor.ts:97

identifier

• identifier: string

Inherited from

HistogramContributor.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

Inherited from

HistogramContributor.intervalListSelection

Defined in

src/contributors/HistogramContributor.ts:61

intervalSelection

• intervalSelection: SelectedOutputValues

New selection current need to be draw on the histogram (could be set to

input() intervalSelection of HistogramComponent

Inherited from

HistogramContributor.intervalSelection

Defined in

src/contributors/HistogramContributor.ts:56

isDataUpdating

• isDataUpdating: boolean

Inherited from

HistogramContributor.isDataUpdating

Defined in

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

isOneDimension

• Protected Optional isOneDimension: boolean

Inherited from

HistogramContributor.isOneDimension

json_path

• Protected json_path: string

Json path to explore element aggregation, count by default

Inherited from

HistogramContributor.json_path

Defined in

src/contributors/HistogramContributor.ts:89

maxBuckets

• maxBuckets: number = 200

to be set in the toolkit when creating the contributor

Inherited from

HistogramContributor.maxBuckets

Defined in

src/contributors/HistogramContributor.ts:120

maxValue

• Protected maxValue: number = 0

Max value of all bucketn use for oneDimension histogram palette

Inherited from

HistogramContributor.maxValue

Defined in

src/contributors/HistogramContributor.ts:109

nbBuckets

• Protected nbBuckets: number

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

Inherited from

HistogramContributor.nbBuckets

Defined in

src/contributors/HistogramContributor.ts:93

range

• range: number

Histogram's range

Inherited from

HistogramContributor.range

Defined in

src/contributors/HistogramContributor.ts:81

selectionExtentPercentage

• selectionExtentPercentage: any

Percentage of current selection extent. This percentage will be used to calculate an offset to add to this extent. offset + selectionextent = data extent

Defined in

src/contributors/DetailedHistogramContributor.ts:46

startValue

• Protected startValue: string

Start value of selection use to the display of filterDisplayName

Inherited from

HistogramContributor.startValue

Defined in

src/contributors/HistogramContributor.ts:101

timeLabel

• timeLabel: any

Labels of the timelines

Inherited from

HistogramContributor.timeLabel

Defined in

src/contributors/HistogramContributor.ts:113

timeShortcuts

• timeShortcuts: StringifiedTimeShortcut[]

List of all the predefined time shortcuts

Inherited from

HistogramContributor.timeShortcuts

Defined in

src/contributors/HistogramContributor.ts:66

timeShortcutsLabels

• timeShortcutsLabels: string[]

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

Inherited from

HistogramContributor.timeShortcutsLabels

Defined in

src/contributors/HistogramContributor.ts:71

useUtc

• useUtc: any

Wether use UTC for display time

Inherited from

HistogramContributor.useUtc

Defined in

src/contributors/HistogramContributor.ts:117

yearShortcutsLabels

• yearShortcutsLabels: string[]

List of years shortcuts labels

Inherited from

HistogramContributor.yearShortcutsLabels

Defined in

src/contributors/HistogramContributor.ts:76

Accessors

updateData

• get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Inherited from

HistogramContributor.updateData

Defined in

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

• set updateData(value): void

Parameters

Name Type Description
value boolean set if the data of contributor should be updated or not.

Returns

void

whether the data of contributor should be updated.

Inherited from

HistogramContributor.updateData

Defined in

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

Methods

computeData

▸ computeData(aggResponses): { chartId: string ; key: number ; value: number }[]

Parameters

Name Type
aggResponses AggregationResponse[]

Returns

{ chartId: string ; key: number ; value: number }[]

Inherited from

HistogramContributor.computeData

Defined in

src/contributors/HistogramContributor.ts:296

fetchData

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

Parameters

Name Type
collaborationEvent? CollaborationEvent

Returns

Observable<AggregationResponse[]>

Overrides

HistogramContributor.fetchData

Defined in

src/contributors/DetailedHistogramContributor.ts:64

fetchDataGivenFilter

▸ Protected fetchDataGivenFilter(identifier, additionalFilters?): Observable<AggregationResponse[]>

Parameters

Name Type
identifier string
additionalFilters? Map<string, Filter>

Returns

Observable<AggregationResponse[]>

Inherited from

HistogramContributor.fetchDataGivenFilter

Defined in

src/contributors/HistogramContributor.ts:341

getAggregations

▸ getAggregations(): Aggregation[]

Returns

Aggregation[]

Inherited from

HistogramContributor.getAggregations

Defined in

src/contributors/HistogramContributor.ts:173

getAllCollections

▸ getAllCollections(): { collectionName: string ; field: string }[]

Returns

{ collectionName: string ; field: string }[]

Inherited from

HistogramContributor.getAllCollections

Defined in

src/contributors/HistogramContributor.ts:289

getConfigValue

▸ getConfigValue(key): any

Parameters

Name Type Description
key string a key defined in configuration.

Returns

any

value of the key in configuration.

Inherited from

HistogramContributor.getConfigValue

Defined in

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

getField

▸ getField(): string

Returns

string

Inherited from

HistogramContributor.getField

Defined in

src/contributors/HistogramContributor.ts:161

getFilterDisplayName

▸ getFilterDisplayName(): string

Returns

string

Pretty name of contribution based on startValue/endValue properties

Inherited from

HistogramContributor.getFilterDisplayName

Defined in

src/contributors/HistogramContributor.ts:210

getJsonPath

▸ getJsonPath(): string

Returns

string

Inherited from

HistogramContributor.getJsonPath

Defined in

src/contributors/HistogramContributor.ts:169

getName

▸ getName(): string

Returns

string

name of contributor set in configuration.

Inherited from

HistogramContributor.getName

Defined in

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

getNbBuckets

▸ getNbBuckets(): number

Returns

number

Inherited from

HistogramContributor.getNbBuckets

Defined in

src/contributors/HistogramContributor.ts:153

getPackageName

▸ getPackageName(): string

Returns

string

Package name for the configuration service.

Overrides

HistogramContributor.getPackageName

Defined in

src/contributors/DetailedHistogramContributor.ts:56

getShortcutLabel

▸ getShortcutLabel(intervalSelection, startValue, endValue): string

Parameters

Name Type
intervalSelection SelectedOutputValues
startValue string
endValue string

Returns

string

Inherited from

HistogramContributor.getShortcutLabel

Defined in

src/contributors/HistogramContributor.ts:260

init

▸ init(aggregations, field, jsonPath, additionalCollections): void

Parameters

Name Type
aggregations Aggregation[]
field string
jsonPath string
additionalCollections CollectionAggField[]

Returns

void

Defined in

src/contributors/DetailedHistogramContributor.ts:111

resolveHistogramAgg

▸ Protected resolveHistogramAgg(identifier, aggregations, collaborations, additionalFilter, ac): Observable<AggregationResponse>

Parameters

Name Type
identifier string
aggregations Aggregation[]
collaborations Map<string, Collaboration>
additionalFilter Filter
ac CollectionAggField

Returns

Observable<AggregationResponse>

Inherited from

HistogramContributor.resolveHistogramAgg

Defined in

src/contributors/HistogramContributor.ts:392

setAggregations

▸ setAggregations(aggregations): void

Parameters

Name Type
aggregations Aggregation[]

Returns

void

Inherited from

HistogramContributor.setAggregations

Defined in

src/contributors/HistogramContributor.ts:199

setData

▸ setData(data): { chartId?: string ; key: number ; value: number }[]

Parameters

Name Type
data { chartId?: string ; key: number ; value: number }[]

Returns

{ chartId?: string ; key: number ; value: number }[]

Inherited from

HistogramContributor.setData

Defined in

src/contributors/HistogramContributor.ts:313

setField

▸ setField(field): void

Parameters

Name Type
field any

Returns

void

Inherited from

HistogramContributor.setField

Defined in

src/contributors/HistogramContributor.ts:165

setName

▸ setName(name): void

Parameters

Name Type
name string

Returns

void

set the name of the contributor

Inherited from

HistogramContributor.setName

Defined in

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

setNbBuckets

▸ setNbBuckets(nbBuckets): void

Parameters

Name Type
nbBuckets number

Returns

void

Inherited from

HistogramContributor.setNbBuckets

Defined in

src/contributors/HistogramContributor.ts:157

setSelection

▸ setSelection(data, collaboration): any

Parameters

Name Type
data { chartId?: string ; key: number ; value: number }[]
collaboration Collaboration

Returns

any

Inherited from

HistogramContributor.setSelection

Defined in

src/contributors/HistogramContributor.ts:331

updateFromCollaboration

▸ updateFromCollaboration(collaborationEvent): void

Parameters

Name Type
collaborationEvent CollaborationEvent

Returns

void

Inherited from

HistogramContributor.updateFromCollaboration

Defined in

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

valueChanged

▸ valueChanged(values, collections?): void

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

Parameters

Name Type Description
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

Inherited from

HistogramContributor.valueChanged

Defined in

src/contributors/HistogramContributor.ts:236

getJsonSchema

▸ Static getJsonSchema(): Object

Returns

Object

Overrides

HistogramContributor.getJsonSchema

Defined in

src/contributors/DetailedHistogramContributor.ts:60