PrxMdService.setTabSheetSelection

Syntax

setTabSheetSelection (report: PP.Prx.Report, metadata: Object, callback);

Parameters

report. Regular report.

metadata. Selected table range.

callback. Callback procedure.

Description

The setTabSheetSelection method saves state of selected table area.

Example

To execute this example, the page must contain the ReportBox component named reportBox (see Example of the ReportBox Component Layout). Select cells in the C2-D2 range:

var prxMdService = reportBox._Service;
// Get regular report source
var prxReport = reportBox.getSource();
// Determine metadata
var metadata = {
    type: "Normal",
    range: {
        height: 0,
        width: 0,
        left: 0,
        top: 0,
        type: "MultiPart",
        parts: {
            it: [{ // Set the cell range to be selected
                height: 1,
                width: 2,
                top: 2,
                left: 2,
                type: "Cells"
            }]
        }
    }
};
// Select table cells
prxMdService.setTabSheetSelection(prxReport, metadata);
// Refresh the report
reportBox.refreshAll();

After executing the example table cells in the C2-D2 range are selected.