PP.App.getQueryParam

Syntax

getQueryParam(key: String, queryString: String);

Parameters

key. Parameter key.

queryString. HTML page URL. The parameter is optional, by default, its value is equal to URL of the current HTML page.

Description

The getQueryParam method returns parameter value for HTML page URL.

Example

To execute the example, open an express report for edit. The scenario specified below must be started in the browser console.

Remove the "mode" and "key" parameters from the URL of the current HTML page:

// Determine whether the current express report is opened for edit
var openMode = PP.App.getQueryParam(PP.App.QueryParamEnum.Mode);
// If edi mode is enabled, remove the "mode" parameter
if (openMode == PP.App.OpenMode.Edit) {
    window.location.href = PP.App.joinQueryParam(PP.App.QueryParamEnum.Mode, null, window.location.href, '&');
};
// Remove the "key" parameter
if (PP.App.getQueryParam(PP.App.QueryParamEnum.Key)) {
    window.location.href = PP.App.joinQueryParam(PP.App.QueryParamEnum.Key, null, window.location.href, '#');
};

After executing the example the "mode" and "key" parameters are removed in the URL of the current HTML page, and a new express report is loaded as the result:

See also:

PP.App