public class Aggregation extends AbstractPivotObject
Constructor and Description |
---|
Aggregation() |
Modifier and Type | Method and Description |
---|---|
Aggregation |
addProperties(java.lang.String... properties) |
java.lang.String |
getCaption() |
java.lang.Boolean |
getCustom() |
JsFunction |
getFunction() |
java.lang.String |
getId() |
AggregationMode |
getMode() |
java.util.List<java.lang.String> |
getProperties() |
Aggregation |
setCaption(java.lang.String caption)
When
Aggregation is set as PivotTableModel.aggregation ,
then caption will be converted to aggregatorName - the name of
the aggregator, used for display purposes in some renderers. |
Aggregation |
setCustom(java.lang.Boolean custom)
Sets whatever a function defined in
function field must be used as the aggregation. |
Aggregation |
setFunction(JsFunction function)
Sets a function which will aggregate results per cell
(see documentation).
|
Aggregation |
setMode(AggregationMode mode)
Sets one of predefined aggregation modes.
|
Aggregation |
setProperties(java.util.List<java.lang.String> properties)
Sets a collection of property names to pass as parameters to selected aggregation.
|
createGsonBuilder, getSharedGson, toString
public java.lang.String getId()
public AggregationMode getMode()
public Aggregation setMode(AggregationMode mode)
Applies only when custom=false
.
mode
- one of predefined aggregation modessetCustom(Boolean)
public java.lang.String getCaption()
public Aggregation setCaption(java.lang.String caption)
Aggregation
is set as PivotTableModel.aggregation
,
then caption
will be converted to aggregatorName
- the name of
the aggregator, used for display purposes in some renderers.
When Aggregation
is added as one of Aggregations.aggregations
,
then caption
will be converted to a key in dictionary of generators
for aggregation functions in dropdown menu.
caption
- a caption of aggregationpublic java.lang.Boolean getCustom()
true
if a function defined in function
field
must be used as the aggregation, false
otherwisepublic Aggregation setCustom(java.lang.Boolean custom)
function
field must be used as the aggregation.custom
- true
if a function defined in function
field
must be used as the aggregation, false
otherwisesetFunction(JsFunction)
public JsFunction getFunction()
public Aggregation setFunction(JsFunction function)
Applies only when custom=true
.
function
- a function which will aggregate results per cellsetCustom(Boolean)
public java.util.List<java.lang.String> getProperties()
public Aggregation setProperties(java.util.List<java.lang.String> properties)
Applies only when custom=false
.
properties
- a collection of property names to pass as parameters to selected aggregationsetCustom(Boolean)
public Aggregation addProperties(java.lang.String... properties)