arlas-web-contributors / 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.
Extends
Constructors
new DetailedHistogramContributor()
new DetailedHistogramContributor(
identifier
,collaborativeSearcheService
,configService
,collection
,isOneDimension
?,additionalCollections
?):DetailedHistogramContributor
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
Inherited from
HistogramContributor
.constructor
Defined in
src/contributors/HistogramContributor.ts:131
Properties
additionalCollections?
optional
additionalCollections:object
[]
collectionName
collectionName:
string
field
field:
string
Inherited from
HistogramContributor
.additionalCollections
Defined in
src/contributors/HistogramContributor.ts:135
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:87
annexedContributorId
annexedContributorId:
any
Id of the histogram contributor which fetches data of the main histogram.
Defined in
src/contributors/DetailedHistogramContributor.ts:42
cacheDuration
protected
cacheDuration:number
Inherited from
HistogramContributor
.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
Inherited from
HistogramContributor
.chartData
Defined in
src/contributors/HistogramContributor.ts:50
chartDataEvent
chartDataEvent:
Subject
\<object
[]>
Inherited from
HistogramContributor
.chartDataEvent
Defined in
src/contributors/HistogramContributor.ts:53
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:52
detailedHistrogramContributor
detailedHistrogramContributor:
DetailedHistogramContributor
Inherited from
HistogramContributor
.detailedHistrogramContributor
Defined in
src/contributors/HistogramContributor.ts:124
endCollaborationEvent
endCollaborationEvent:
Subject
\<CollaborationEvent
>
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
Defined in
src/contributors/HistogramContributor.ts:107
field
protected
field:string
ARLAS Server field of aggregation used to draw the chart, retrieve from Aggregation
Inherited from
Defined in
src/contributors/HistogramContributor.ts:99
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:63
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:58
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
Defined in
src/contributors/HistogramContributor.ts:134
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:91
linkedContributorId
linkedContributorId:
string
Inherited from
HistogramContributor
.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
Inherited from
HistogramContributor
.maxBuckets
Defined in
src/contributors/HistogramContributor.ts:122
maxValue
protected
maxValue:number
=0
Max value of all bucketn use for oneDimension histogram palette
Inherited from
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.
Inherited from
HistogramContributor
.nbBuckets
Defined in
src/contributors/HistogramContributor.ts:95
range
range:
number
Histogram's range
Inherited from
Defined in
src/contributors/HistogramContributor.ts:83
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:47
startValue
protected
startValue:string
Start value of selection use to the display of filterDisplayName
Inherited from
HistogramContributor
.startValue
Defined in
src/contributors/HistogramContributor.ts:103
timeLabel
timeLabel:
any
Labels of the timelines
Inherited from
HistogramContributor
.timeLabel
Defined in
src/contributors/HistogramContributor.ts:115
timeShortcuts
timeShortcuts:
StringifiedTimeShortcut
[]
List of all the predefined time shortcuts
Inherited from
HistogramContributor
.timeShortcuts
Defined in
src/contributors/HistogramContributor.ts:68
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:73
useUtc
useUtc:
any
Wether use UTC for display time
Inherited from
Defined in
src/contributors/HistogramContributor.ts:119
yearShortcutsLabels
yearShortcutsLabels:
string
[]
List of years shortcuts labels
Inherited from
HistogramContributor
.yearShortcutsLabels
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
HistogramContributor
.updateData
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:49
Methods
computeData()
computeData(
aggResponses
):object
[]
Parameters
aggResponses
AggregationResponse
[]
Returns
object
[]
Inherited from
HistogramContributor
.computeData
Defined in
src/contributors/HistogramContributor.ts:304
fetchData()
fetchData(
collaborationEvent
?):Observable
\<AggregationResponse
[]>
Parameters
collaborationEvent?
CollaborationEvent
Returns
Observable
\<AggregationResponse
[]>
Overrides
HistogramContributor
.fetchData
Defined in
src/contributors/DetailedHistogramContributor.ts:65
fetchDataGivenFilter()
protected
fetchDataGivenFilter(identifier
,additionalFilters
?):Observable
\<AggregationResponse
[]>
Parameters
identifier
string
additionalFilters?
Map
\<string
, Filter
>
Returns
Observable
\<AggregationResponse
[]>
Inherited from
HistogramContributor
.fetchDataGivenFilter
Defined in
src/contributors/HistogramContributor.ts:349
getAggregations()
getAggregations():
Aggregation
[]
Returns
Aggregation
[]
Inherited from
HistogramContributor
.getAggregations
Defined in
src/contributors/HistogramContributor.ts:181
getAllCollections()
getAllCollections():
object
[]
Returns
object
[]
Inherited from
HistogramContributor
.getAllCollections
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
HistogramContributor
.getConfigValue
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:34
getField()
getField():
string
Returns
string
Inherited from
Defined in
src/contributors/HistogramContributor.ts:169
getFilterDisplayName()
getFilterDisplayName():
string
Returns
string
Pretty name of contribution based on startValue/endValue properties
Inherited from
HistogramContributor
.getFilterDisplayName
Defined in
src/contributors/HistogramContributor.ts:218
getJsonPath()
getJsonPath():
string
Returns
string
Inherited from
HistogramContributor
.getJsonPath
Defined in
src/contributors/HistogramContributor.ts:177
getName()
getName():
string
Returns
string
name of contributor set in configuration.
Inherited from
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:41
getNbBuckets()
getNbBuckets():
number
Returns
number
Inherited from
HistogramContributor
.getNbBuckets
Defined in
src/contributors/HistogramContributor.ts:161
getPackageName()
getPackageName():
string
Returns
string
Package name for the configuration service.
Overrides
HistogramContributor
.getPackageName
Defined in
src/contributors/DetailedHistogramContributor.ts:57
getShortcutLabel()
getShortcutLabel(
intervalSelection
,startValue
,endValue
):string
Parameters
intervalSelection
SelectedOutputValues
startValue
string
endValue
string
Returns
string
Inherited from
HistogramContributor
.getShortcutLabel
Defined in
src/contributors/HistogramContributor.ts:268
init()
init(
aggregations
,field
,jsonPath
,additionalCollections
):void
Parameters
aggregations
Aggregation
[]
field
string
jsonPath
string
additionalCollections
CollectionAggField
[]
Returns
void
Defined in
src/contributors/DetailedHistogramContributor.ts:125
isMyLinkedContributorCollaboration()
isMyLinkedContributorCollaboration(
collaborationEvent
):boolean
Parameters
collaborationEvent
CollaborationEvent
Returns
boolean
Inherited from
HistogramContributor
.isMyLinkedContributorCollaboration
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:37
isMyOwnCollaboration()
isMyOwnCollaboration(
collaborationEvent
):boolean
Parameters
collaborationEvent
CollaborationEvent
Returns
boolean
Inherited from
HistogramContributor
.isMyOwnCollaboration
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:36
isUpdateEnabledOnOwnCollaboration()
isUpdateEnabledOnOwnCollaboration():
boolean
Returns
boolean
Inherited from
HistogramContributor
.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
>
Inherited from
HistogramContributor
.resolveHistogramAgg
Defined in
src/contributors/HistogramContributor.ts:403
setAggregations()
setAggregations(
aggregations
):void
Parameters
aggregations
Aggregation
[]
Returns
void
Inherited from
HistogramContributor
.setAggregations
Defined in
src/contributors/HistogramContributor.ts:207
setData()
setData(
data
):object
[]
Parameters
data
object
[]
Returns
object
[]
Inherited from
Defined in
src/contributors/HistogramContributor.ts:321
setField()
setField(
field
):void
Parameters
field
any
Returns
void
Inherited from
Defined in
src/contributors/HistogramContributor.ts:173
setName()
setName(
name
):void
Parameters
name
string
Returns
void
set the name of the contributor
Inherited from
Defined in
node_modules/arlas-web-core/models/contributor.d.ts:45
setNbBuckets()
setNbBuckets(
nbBuckets
):void
Parameters
nbBuckets
number
Returns
void
Inherited from
HistogramContributor
.setNbBuckets
Defined in
src/contributors/HistogramContributor.ts:165
setSelection()
setSelection(
data
,collaboration
):any
Parameters
data
object
[]
collaboration
Collaboration
Returns
any
Inherited from
HistogramContributor
.setSelection
Defined in
src/contributors/HistogramContributor.ts:339
updateFromCollaboration()
updateFromCollaboration(
collaborationEvent
):void
Parameters
collaborationEvent
CollaborationEvent
Returns
void
Inherited from
HistogramContributor
.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
Inherited from
HistogramContributor
.valueChanged
Defined in
src/contributors/HistogramContributor.ts:244
getJsonSchema()
static
getJsonSchema():Object
Returns
Object
Overrides
HistogramContributor
.getJsonSchema
Defined in
src/contributors/DetailedHistogramContributor.ts:61