add_field


Description:

[ Version ( since = "5.0" ) ]
public bool add_field (DataPivotFieldType field_type, string field, string? alias) throws Error

Specifies that field has to be included in the analysis.

field is a field specification with the following accepted syntaxes:

  • a column name in the source data model (see gda_data_model_get_column_index); or
  • an SQL expression involving a column name in the source data model, for example:

    price
    firstname || ' ' || lastname
    nb BETWEEN 5 AND 10

It is also possible to specify several fields to be added, while separating them by a comma (in effect still forming a valid SQL syntax).

Parameters:

this

a DataPivot object

field_type

the type of field to add

field

the field description, see below

alias

the field alias, or null

Returns:

true if no error occurred