Skip to content

arlas-web-contributors > "contributors/DetailedHistogramContributor" > 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

HistogramContributor

↳ DetailedHistogramContributor

Index

Constructors

Properties

Methods


Constructors

constructor

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

Inherited from HistogramContributor.constructor

Overrides Contributor.__constructor

Defined in contributors/HistogramContributor.ts:104

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


Properties

<Protected> aggregations

● aggregations: Array<Aggregation> = this.getConfigValue('aggregationmodels')

Inherited from HistogramContributor.aggregations

Defined in contributors/HistogramContributor.ts:76

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


annexedContributorId

● annexedContributorId: any = this.getConfigValue('annexedContributorId')

Defined in contributors/DetailedHistogramContributor.ts:39

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


chartData

● chartData: Array<object> = new Array<{ key: number, value: number }>()

Inherited from HistogramContributor.chartData

Defined in contributors/HistogramContributor.ts:47

New data need to be draw on the histogram (could be set to input(): data of HistogramComponent


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


currentSelectedInterval

● currentSelectedInterval: SelectedOutputValues

Defined in contributors/DetailedHistogramContributor.ts:49

The current selection on the main histogram


<Protected> endValue

● endValue: string

Inherited from HistogramContributor.endValue

Defined in contributors/HistogramContributor.ts:96

End value of selection use to the display of filterDisplayName


<Protected> field

● field: string = (this.aggregations !== undefined) ? (this.aggregations[this.aggregations.length - 1].field) : (undefined)

Inherited from HistogramContributor.field

Defined in contributors/HistogramContributor.ts:88

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


identifier

● identifier: string

Inherited from Contributor.identifier

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


intervalListSelection

● intervalListSelection: SelectedOutputValues[] = []

Inherited from HistogramContributor.intervalListSelection

Defined in contributors/HistogramContributor.ts:57

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


intervalSelection

● intervalSelection: SelectedOutputValues

Inherited from HistogramContributor.intervalSelection

Defined in contributors/HistogramContributor.ts:52

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


<Protected>``<Optional> isOneDimension

● isOneDimension: boolean

Inherited from HistogramContributor.isOneDimension

Defined in contributors/HistogramContributor.ts:114


<Protected> maxValue

● maxValue: number = 0

Inherited from HistogramContributor.maxValue

Defined in contributors/HistogramContributor.ts:100

Max value of all bucketn use for oneDimension histogram palette


<Protected> nbBuckets

● nbBuckets: number = this.getConfigValue('numberOfBuckets')

Inherited from HistogramContributor.nbBuckets

Defined in contributors/HistogramContributor.ts:84

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


range

● range: RangeResponse

Inherited from HistogramContributor.range

Defined in contributors/HistogramContributor.ts:72

Histogram's range


selectionExtentPercentage

● selectionExtentPercentage: any = this.getConfigValue('selectionExtentPercentage')

Defined in contributors/DetailedHistogramContributor.ts:44

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


<Protected> startValue

● startValue: string

Inherited from HistogramContributor.startValue

Defined in contributors/HistogramContributor.ts:92

Start value of selection use to the display of filterDisplayName


timeLabel

● timeLabel: any

Inherited from HistogramContributor.timeLabel

Defined in contributors/HistogramContributor.ts:104

Labels of the timelines


timeShortcuts

● timeShortcuts: Array<StringifiedTimeShortcut>

Inherited from HistogramContributor.timeShortcuts

Defined in contributors/HistogramContributor.ts:62

List of all the predefined time shortcuts


timeShortcutsLabels

● timeShortcutsLabels: Array<string> = this.getConfigValue('timeShortcuts')

Inherited from HistogramContributor.timeShortcutsLabels

Defined in contributors/HistogramContributor.ts:67

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


Methods

computeData

computeData(aggResponse: AggregationResponse): Array<object>

Inherited from HistogramContributor.computeData

Overrides Contributor.computeData

Defined in contributors/HistogramContributor.ts:193

Parameters:

Name Type
aggResponse AggregationResponse

Returns: Array<object>


fetchData

fetchData(collaborationEvent?: CollaborationEvent): Observable<AggregationResponse>

Overrides HistogramContributor.fetchData

Defined in contributors/DetailedHistogramContributor.ts:62

Parameters:

Name Type
Optional collaborationEvent CollaborationEvent

Returns: Observable<AggregationResponse>


<Protected> fetchDataGivenFilter

fetchDataGivenFilter(identifier: string, additionalFilter?: Filter): Observable<AggregationResponse>

Inherited from HistogramContributor.fetchDataGivenFilter

Defined in contributors/HistogramContributor.ts:230

Parameters:

Name Type
identifier string
Optional additionalFilter Filter

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

Inherited from HistogramContributor.getFilterDisplayName

Overrides Contributor.getFilterDisplayName

Defined in contributors/HistogramContributor.ts:134

Returns: string Pretty name of contribution based on startValue/endValue properties


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

Defined in contributors/DetailedHistogramContributor.ts:54

Returns: string Package name for the configuration service.


getShortcutLabel

getShortcutLabel(intervalSelection: SelectedOutputValues, startValue: string, endValue: string): string

Inherited from HistogramContributor.getShortcutLabel

Defined in contributors/HistogramContributor.ts:165

Parameters:

Name Type
intervalSelection SelectedOutputValues
startValue string
endValue string

Returns: string


setData

setData(data: Array<object>): Array<object>

Inherited from HistogramContributor.setData

Overrides Contributor.setData

Defined in contributors/HistogramContributor.ts:207

Parameters:

Name Type
data Array<object>

Returns: Array<object>


setSelection

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

Inherited from HistogramContributor.setSelection

Overrides Contributor.setSelection

Defined in contributors/HistogramContributor.ts:219

Parameters:

Name Type
data Array<object>
collaboration Collaboration

Returns: any


valueChanged

valueChanged(values: SelectedOutputValues[]): void

Inherited from HistogramContributor.valueChanged

Defined in contributors/HistogramContributor.ts:157

Set filter on value change, use in output of component

Parameters:

Name Type
values SelectedOutputValues[]

Returns: void


<Static> getJsonSchema

getJsonSchema(): Object

Overrides HistogramContributor.getJsonSchema

Defined in contributors/DetailedHistogramContributor.ts:58

Returns: Object