arlas-web-contributors / MetricsVector
Class: MetricsVector
A MetricsVector reprensents a collection with all its metrics.
It provides getAggregationmethod that returns the arlas-api Aggregation request object.
| | MetricsVector 1 |
| | (c1,f1,m1) | (c1,f2,m2) |
| term 1 | x | x |
| term 2 | x | x |
Constructors
new MetricsVector()
new MetricsVector(
collection,termfield,configuration,sortConfig,nbTerms):MetricsVector
Parameters
collection
string
termfield
string
configuration
sortConfig
MetricsTableSortConfig
nbTerms
number
Returns
Defined in
src/models/metrics-table.config.ts:143
Properties
collection
collection:
string
Defined in
src/models/metrics-table.config.ts:137
configuration
configuration:
MetricsVectorConfig
Defined in
src/models/metrics-table.config.ts:139
nbTerms
nbTerms:
number
Defined in
src/models/metrics-table.config.ts:140
sort
sort:
MetricsTableSortConfig
Defined in
src/models/metrics-table.config.ts:141
termfield
termfield:
string
Defined in
src/models/metrics-table.config.ts:138
Methods
getAggregation()
getAggregation(
termsToInclude?):Aggregation
Parameters
termsToInclude?
string[]
Returns
Aggregation
Defined in
src/models/metrics-table.config.ts:180
getColumns()
getColumns():
MetricsTableColumn[]
Returns
MetricsTableColumn[]
Defined in
src/models/metrics-table.config.ts:240
hasCount()
hasCount():
boolean
Returns
boolean
Defined in
src/models/metrics-table.config.ts:156
isSortable()
isSortable():
boolean
This method detects if this vector should be sorted by arlas-server
Returns
boolean
Defined in
src/models/metrics-table.config.ts:161
mergeResponses()
mergeResponses(
baseResponse,complementaryResponse):AggregationResponse
Parameters
baseResponse
AggregationResponse
complementaryResponse
AggregationResponse
Returns
AggregationResponse
Defined in
src/models/metrics-table.config.ts:281
id()
staticid(mvc):string
Parameters
mvc
Returns
string
Defined in
src/models/metrics-table.config.ts:152