CubePivotField Class

The default value for this property is Aggregate.Sum for numeric fields, and Aggregate.Count for other field types.

The default value for this property is null, which causes the grid to select the alignment automatically based on the fields's dataType (numbers are right-aligned, Boolean values are centered, and other types are left-aligned).

If you want to override the default alignment, set this property to 'left', 'right', 'center', or 'justify'.

The default value for this property is false.

For measure fields in cube data sources, the filter is applied to aggregated cell values. For measure fields in non-cube data sources, the filter is applied to the raw data.

The default value for this property is "d" for date fields, "n0" for numeric fields, and the empty string for other field types.

The default value for this property is null, causing the engine to use the field's aggregate and showAs properties to calculate the aggregate.

If specified, the function should take a single parameter that represents the summary object generated by the engine and should return the aggregate value for the item.

Notice the difference between the getValue property (a function that takes a raw data item and returns a raw value), and the getAggregateValue (a function that takes a summary object and returns an aggregate value):

fields: [
    {
        header: 'Conversion (per summary row)',
        dataType: 'Number',
        format: 'p0',

        // getAggregateValue computes an aggregate from a summary row (Downloads, Sales)
        // **NOTE**: for this formula to work, the "Downloads" and "Sales" fields must be
        // present in the PivotEngine's valueFields array.
        getAggregateValue: row => row.Downloads ? row.Sales / row.Downloads : 0
    },
    {
        header: 'Conversion (per raw data item)',
        dataType: 'Number',
        aggregate: 'Avg',
        format: 'p0',

        // getValue computes a raw value from a data item (downloads, sales)
        getValue: item => item.downloads ? item.sales / item.downloads : 0
},

Example

This property is set to null by default, causing the engine to use the field's binding property to retrieve the value.

If specified, the function should take a single parameter that represents the data item being evaluated and should return the calculated value for the item.

Notice the difference between the getValue property (a function that takes a raw data item and returns a raw value), and the getAggregateValue (a function that takes a summary object and returns an aggregate value):

fields: [
    {
        header: 'Conversion (per summary row)',
        dataType: 'Number',
        format: 'p0',

        // getAggregateValue computes an aggregate from a summary row (Downloads, Sales)
        getAggregateValue: row => row.Downloads ? row.Sales / row.Downloads : 0
    },
    {
        header: 'Conversion (per raw data item)',
        dataType: 'Number',
        aggregate: 'Avg',
        format: 'p0',

        // getValue computes a raw value from a data item (downloads, sales)
        getValue: item => item.downloads ? item.sales / item.downloads : 0
},

Example

Setting this property to true causes the field to be added to the view's PivotEngine.rowFields or PivotEngine.valueFields, depending on the field's data type.

The default value for this property is false.

When you drag the same field into the Values list multiple times, copies of the field are created so you can use the same binding with different parameters. The copies keep a reference to their parent fields.

Options for this property are defined by the ShowAs enumeration and include differences between the value and the one in the previous row or column, percentages over the row, column, or grand total, and running totals.

This property is similar to the Show Values As feature in Excel.

The default value for this property is ShowAs.NoCalculation.

This sortComparer property is effective for the fields specified in the PivotEngine.columnFields and PivotEngine.columnFields properties only.

If provided, the sort comparer function should take as parameters two values of any type, and should return -1, 0, or +1 to indicate whether the first value is smaller than, equal to, or greater than the second. If the sort comparer returns null, the standard built-in comparer is used.

This sortComparer property allows you to use custom comparison algorithms that in some cases result in sorting sequences that are more consistent with user's expectations than plain string comparisons.

The example below shows a typical use for the sortComparer property:

// define list of products
app.products = 'Wijmo,Aoba,Olap,Xuni'.split(',');

// sort products by position in the 'app.products' array
ng.viewDefinitionChanged.addHandler(function () {
  var fld = ng.fields.getField('Product');
  if (fld) {
    fld.sortComparer = function (val1, val2) {
      return app.products.indexOf(val1) - app.products.indexOf(val2);
    }
  }
});

The default value for this property is true.

Setting this property to false hides the field any PivotPanel controls, preventing users from adding, removing, or changing the the field position in the engine's view definition.

If this property is set to null, all values are assumed to have weight one.

This property allows you to calculate weighted averages and totals. For example, if the data contains a 'Quantity' field and a 'Price' field, you could use the 'Price' field as a value field and the 'Quantity' field as a weight. The output would contain a weighted average of the data.

The default value for this property is false.