All documentation
  • API Reference for older versions
  • setOptions

    setOptions(options: OptionsObject)

    [starting from version: 1.6]

    Sets the component's options.

    Use the refresh() API call after to redraw the component and see changes.

    Parameters

    Parameter/TypeDescription
    options
    OptionsObject
    Contains the list of component's options and their new values.
    Note that changes to the following options take effect only after reloading the report (e.g., using setReport()):

    Examples

    1) How to set grid title:

    pivot.setOptions({
    grid: {
    title: "Table One"
    }
    });
    pivot.refresh();

    Check the example on JSFiddle.

    2) How to turn off totals:

    var options = pivot.getOptions();
    options.grid.showTotals = "off";
    pivot.setOptions(options);
    pivot.refresh();

    Try on JSFiddle.

    3) How to set a chart title:

    pivot.setOptions({
    chart: {
    title: "Chart One"
    }
    });
    pivot.refresh();

    See also

    OptionsObject
    getOptions
    refresh
    Options tutorial