Skip to main content
Pentaho Documentation

Get/Set Report Options APIs

Overview

Quisque mattis rutrum ligula et pellentesque. Pellentesque massa enim, pulvinar quis quam quis, aliquet dapibus augue. Aliquam feugiat suscipit turpis, nec ultrices dolor adipiscing ut.

How to Call These APIs

There are two calls related to Report Options: getReportOption and setReportOption.

  • The setReportOption is used to designate a value for a specific report option.
  • The getReportOption allows you to view the current value assigned to that option.
cv.api.report.setReportOption(name:string, value:string);
cv.api.report.getReportOption(name:string);

To ensure your changes are reflected in the report, the refreshReport method should be called:

cv.api.operation.refreshReport();

Acceptable values for setting a report option are 'true' and 'false'. The getReportOption returns one of these same values.

Report Options

The following lists report options.

showRowGrandTotal

This option allows you to set the visibility of row grand totals for the pivot table.

cv.api.report.setReportOption("showRowGrandTotal", "true");
cv.api.report.getReportOption("showRowGrandTotal"); // Returns "true"

showColumnGrandTotal

This option allows you to set the visibility of column grand totals for the pivot table.

cv.api.report.setReportOption("showColumnGrandTotal", "true");
cv.api.report.getReportOption("showColumnGrandTotal"); // Returns "true"

useNonVisualTotals

This option allows you to set the visibility of non-visual totals for the pivot table.

cv.api.report.setReportOption("useNonVisualTotals", "true");
cv.api.report.getReportOption("useNonVisualTotals"); // Returns "true"

showEmptyCells (Deprecated)

This option has been deprecated. Please use showEmptyEnum.

This option allows you to set the visibility of cells with no data.

cv.api.report.setReportOption("showEmptyCells", "true");
cv.api.report.getReportOption("showEmptyCells"); // Returns "true"

showEmptyEnum

This option allows the user to set the options available for the parameter via a drop-down menu. The following values are allowed:

  • SHOW_MEASURE - Includes measure data. Default value.
  • SHOW_CALCULATED_MEASURE - Includes measure and calculated measure data.
  • SHOW_EMPTY - Includes all measure and calculated measure data, including null measure data.
cv.api.report.setReportOption("showEmptyEnum", "SHOW_MEASURE");
cv.api.report.getReportOption("showEmptyEnum"); // Returns "SHOW_MEASURE"

showDrillLinks

This option allows you to set the visibility of drill-through links on cells for pivot table.

cv.api.report.setReportOption("showDrillLinks", "true");
cv.api.report.getReportOption("showDrillLinks"); // Returns "true"

autoRefresh

This option allows you to set the ability to automatically refresh the report when a user makes a report definition change.

cv.api.report.setReportOption("autoRefresh", "true");
cv.api.report.getReportOption("autoRefresh"); // Returns "true"

freezeColumns

This option allows you to set the freezing of the column headers in the pivot table when the user scrolls.

cv.api.report.setReportOption("freezeColumns", "true");
cv.api.report.getReportOption("freezeColumns"); // Returns "true"

freezeRows

This option allows you to set the freezing of the row headers in the pivot table when the user scrolls.

cv.api.report.setReportOption("freezeRows", "true");
cv.api.report.getReportOption("freezeRows"); // Returns "true"

URL Parameters

All of the above report options can also be set through the URL as URL parameters.

http://localhost:8080/pentaho/api/repos/%3Apublic%3ASteel%20Wheels%3ALeading%20Product%20Lines%20(pivot%20table).xanalyzer/editor?ts=1421660200377&showRowGrandTotal=true&showColumnGrandTotal=true&useNonVisualTotals=true&showEmptyCells=true&showDrillLinks=true&autoRefresh=true&freezeColumns=true&freezeRows=true