Module
HistogramAggregation
HistogramAggregation ( name )
Aggregation that can be applied on numeric values extracted from the documents.
|
Method Summary
| Returns | Name | Description |
|---|---|---|
String | _type() | The type of ejs object. For internal use only. |
Object | agg(agg) | Add a nesated aggregation. This method can be called multiple times in order to set multiple nested aggregations what will be executed at the same time as the parent aggregation. Alias for the aggregation method. |
Object | aggregation(agg) | Add a nesated aggregation. This method can be called multiple times in order to set multiple nested aggregations what will be executed at the same time as the parent aggregation. |
Object | extendedBounds(min,max) | Set's the range/bounds for the histogram aggregation. Useful when you want to include buckets that might be outside the bounds of indexed documents. |
Object | field(field) | Sets the field to operate on. |
Object | format(f) | Sets the format expression for the terms. Use for number or date formatting |
Object | interval(i) | Sets the histogram interval. Buckets are generated based on this interval value. |
Object | keyed(trueFalse) | Enable the response to be returned as a keyed object where the key is the bucket interval. |
Object | lang(language) | The script language being used. |
Object | minDocCount(num) | Only return terms that match more than a configured number of hits. |
Object | order(order,direction) | Sets order for the aggregated values. |
Object | params(p) | Sets parameters that will be applied to the script. Overwrites any existing params. |
Object | script(scriptCode) | Allows you generate or modify the terms/values using a script. |
Object | scriptFile(scriptFile) | Allows you generate or modify the terms/values using a script. |
Object | scriptId(scriptId) | Allows you generate or modify the terms/values using a script. |
String | toJSON() | Retrieves the internal |
Method Detail
agg
Object agg ( agg )
Add a nesated aggregation. This method can be called multiple times
in order to set multiple nested aggregations what will be executed
at the same time as the parent aggregation. Alias for the
aggregation method.
|
aggregation
Object aggregation ( agg )
Add a nesated aggregation. This method can be called multiple times
in order to set multiple nested aggregations what will be executed
at the same time as the parent aggregation.
|
extendedBounds
Object extendedBounds ( min, max )
Set's the range/bounds for the histogram aggregation. Useful when you
want to include buckets that might be outside the bounds of indexed
documents.
|
field
Object field ( field )
Sets the field to operate on.
|
format
Object format ( f )
Sets the format expression for the terms. Use for number or date
formatting
|
interval
Object interval ( i )
Sets the histogram interval. Buckets are generated based on this interval
value.
|
keyed
Object keyed ( trueFalse )
Enable the response to be returned as a keyed object where the key is the
bucket interval.
|
lang
Object lang ( language )
The script language being used.
|
minDocCount
Object minDocCount ( num )
Only return terms that match more than a configured number of hits.
|
order
Object order ( order, direction )
Sets order for the aggregated values.
|
params
Object params ( p )
Sets parameters that will be applied to the script. Overwrites
any existing params.
|
script
Object script ( scriptCode )
Allows you generate or modify the terms/values using a script.
|
scriptFile
Object scriptFile ( scriptFile )
Allows you generate or modify the terms/values using a script.
|
scriptId
Object scriptId ( scriptId )
Allows you generate or modify the terms/values using a script.
|
toJSON
String toJSON ( )
Retrieves the internal
|