Documentation menu

FieldObject

The FieldObject describes a field selected in the slice.

Properties

Property/TypeDescription
nameStringoptionalThe field's unique name.
aggregationStringoptionalThe name of the aggregation that will be applied to the value. Only for the flat table.
showTotalBooleanoptionalDefines whether totals are shown or hidden for the field. When set to false, totals are hidden. The totalRowPosition option overrides showTotal. If totalRowPosition is "none", totals are not displayed regardless of the showTotal value. Only for the flat table.

Examples

  1. See how fields are configured for the pivot table:
slice: {
  rows: [
    {
    name: "Country"
    },
  ],
  columns: [
    {
      name: "Category"
    }
  ],
  values: [
    {
      name: "Price",
      aggregation: "average",
      showTotal: false
    }
  ]
}
  1. See how fields are configured for the flat table:
slice: {
  fields: [
    {
      name: "Country",
      aggregation: "sum"
    },
    {
      name: "Price",
      aggregation: "average",
      showTotal: false
    }
  ]
}