Skip to content

getCalculatedValues

This function allows you to call to another report, calculate it in the background without rendering it to the user and return the values from a given range.

Syntax

getCalculatedValues (reportname, range, queryString, isPrivate, publisher)

Arguments

reportName

(Required)

The name of the report which you want to perform a background calculation on

range

(Required) 

The range to return. This can be any of the following:

  • A1 reference
  • R1C1 reference
  • A1:B6 reference
  • Named range

queryString

Any additional query string arguments you want to pass in for the calculation of the report

Default value: ”“

isPrivate

Is this a private report

Default value: false

publisher

If it is a private report, specify the login id of the user that published it.

Default value: ”“

Return

The result of this function is a JavaScript string array of values in the following format

Example

//
// Example 1 - Calculate the named public report and retrieve range A1
//
var values1 = report.api.getCalculatedValues("MyTestReport", "A1");

//
// Example 2 - Calculate the named public report and retrieve range A1:B3
//
var values2 = report.api.getCalculatedValues("MyTestReport", "A1:B3");

//
// Example 3 - Calculate the named public report with some query string parameters and retrieve range A1:B3
//
var queryString = "[Date].[Date].%26[2]&R1C3=Yesterday"
var values3 = report.api.getCalculatedValues("MyTestReport", "A1:B3", queryString);

//
// Example 4 - Calculate the named private report and retrieve range A1:B3
//
var values4 = report.api.getCalculatedRange("MyTestReport", "A1:B3", "", true, "sgibbs");