Deprecated methods

With the release of ActiveReportsJS v4.0, we've introduced a new API for programmatically setting, validating, and resolving default values for report parameters. As a result, the existing API has been deprecated and will be removed in the next major version. This document provides a list of deprecated API members and their respective replacements in v4.0.

Setting Parameters Values

A common use case for programmatically setting parameter values is exporting a report to one of the supported formats. Before v4.0, you would use the parameters property of the PageReport class instance, as demonstrated in the following code snippet:

import {Core} from "@grapecity/activereports";

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);
report.parameters["Header"].values = ["Product List"]; // string single value parameter
report.parameters["SupplierIds"].values = [1,2,3]; // integer multi value parameter

The parameters property is now deprecated. Instead, you can use one of two alternatives.

Alternative 1: Passing parameter values to the load method

The load method now accepts the parameters values:

import {Core} from "@grapecity/activereports";

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`, {
    reportParameters: [{
        Name: 'Header',
        Value: ['Product List']
    }, {
        Name: 'SupplierIds',
        Value: [1,2,3]
    }]
});

Alternative 2: Using the applySteps method of the reportParameters object

The PageReport class instance now exposes a reportParameters object with an applySteps method for setting parameter values in various advanced scenarios:

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);
report.reportParameters.applySteps([
  {
    Name: "Header",
    Value: "Product List",
    Type: "Set",
  },
  {
    Name: "SupplierIds",
    Value: [1, 2, 3],
    Type: "Set",
  },
]);

Resolving default parameters values

Previously, if a report parameter had a default value, you needed to call the resolveParametersValues method of the PageReport class instance before exporting a report. In v4.0, this method has been deprecated, and default values are resolved automatically.

Validating parameters values

The validateParameters method of the PageReport class has been deprecated. Instead, use the validate method of the reportParameters object:

import {Core} from "@grapecity/activereports";

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`, {
    reportParameters: [{
        Name: 'Header',
        Value: ['Product List']
    }, {
        Name: 'SupplierIds',
        Value: [1,2,3]
    }]
});
const validationResult = report.reportParameters.validate();
if(!validationResult['SupplierIds'].isValid)
  console.log('Invalid SupplierIds value: ', validationResult['SupplierIds'].message);