add-field

Description

Fires when a new field is added to the rows, columns or values area

Usage

"add-field": ({
    id?: string | number,
    area: string,
    field: string | number,
    method?: string
}) => boolean;

Parameters

The callback of the action takes an object with the following parameters:

• id - (optional) the desired id of a new field; if it's not set, the auto-generated id is added
• area - (required) the name of the area where a new field is added, which can be "rows", "columns" or "values" area
• field - (required) the name of a field
• method - (optional) defines a method for data aggregation (if not specified, the first method suitable for this data type is set); a method can be one of the following:
  • it's required for the values area, it's a string with one of the data operation types: Default methods
  • it's optional for the rows and columns areas and if the value is set it's a predicate; it can be a custom predicate or one from default values: "year", "quarter", "month", "week", "day", "hour", "minute". By default, a raw value is set. If a custom predicate or method is set, the id should be specified for the predicates or methods property.

info

For handling the inner events you can use the Event Bus methods

Example

In the example below we use the api.intercept() method to add a new method to the value field with the number data type:

const table = new pivot.Pivot("#root", {
    fields,
    data: dataset,
    config: {
        rows: ["studio", "genre"],
        columns: [],
        values: [
            {
                field: "title",
                method: "count"
            },
            {
                field: "score",
                method: "max"
            }
        ]
    }
});
//adding values with a predefined method
table.api.intercept("add-field", (ev) => {
    const { fields } = table.api.getState();
    const type = fields.find((f) => f.id == ev.field).type;

    if (ev.area == "values" && type == "number") {
        ev.method = "min";
    }
});

Related articles: api.intercept()