Progress® Telerik® Reporting R1 2021

New to Telerik Reporting? Download free 30-day trial

Options

Below is a list of all options available during initialization.

Options

Parameter	Description
id	string, optional; Sets the unique identifier of the ReportViewer instance. If not specified, the id of the target HTML element will be used (if such is set). The id of the ReportViewer is used to identify the client session of the viewer when persistSession is enabled (true);
serviceUrl	string, required if reportServer not used ; Sets the address of the Report REST Service;
reportServer	JSON, required if serviceUrl not used ; Sets the configuration details for Telerik Report Server. Available properties: url (string, required) - the URL to the Telerik Report Server instance. username (string, optional) - a registered username in Report Server that will be used to get access to the reports. If omitted, the Report Server built-in Guest account will be used; password (string, optional) - the password for the provided username. Can be omitted only when connecting with the Guest account.
templateUrl	string, optional; Sets the address of the html page that contains the viewer templates; If omitted, the default template will be downloaded from the REST service.
reportSource	JSON, optional; Sets the report and initial report parameter values for the viewer to be displayed. Available properties: report - a string that represents a report on the server. On the server side this string will be converted to a ReportSource through an IReportResolver. That said this string may contain everything as far as the Telerik Reporting REST Services knows how to convert to a reports source that will be passed to the report engine for further processing. For example this may be an assembly qualified type name that can be converted to TypeReportSource, a path to a report definition file (.trdp/.trdx) as in the UriReportSource, or even a report id that a dedicated IReportSourceResolver will use to read the report definition stored in a database in xml format and converted to a XmlReportSource. parameters - a JSON object with properties name/value equal to the report parameters’ names and values used in the report definition;
sendEmail	object, required to show the Send Mail Message button, and predefine some of the dialog values ; Available properties: enabled (bool, required) - Indicates whether to show the Send Mail Message toolbar button. Default value: false; from (string, optional) - E-mail address used for the MailMessage FROM value; to (string, optional) - E-mail address used for the MailMessage TO value; cc (string, optional) - E-mail address used for the MailMessage Carbon Copy value; subject (string, optional) - A string used for the MailMessage Subject value; body (string, optional) - Sentences used for the MailMessage Content value; format (string, optional) - The preselected report document format.
scale	number, optional; Sets the scale factor for the report pages. The scale takes effect when scaleMode is set to “SPECIFIC”. Default value is 1.0 (100%);
scaleMode	string, optional; Sets how the report pages to be scaled. Available options are: “FIT_PAGE_WIDTH” - the pages are scaled proportional to fit the entire width in the viewer’s view port; “FIT_PAGE” - the pages are scaled proportional to fit the entire page in the view port; “SPECIFIC” - the pages are scaled with the scale value; Default value is: “FIT_PAGE”.
viewMode	string, optional; Sets if the report is displayed in interactive mode or in print preview. The available values are: “INTERACTIVE” - enables drill-down interactivity, etc; “PRINT_PREVIEW” - the report is paged according to the page settings; For more information please see Interactive vs. Print Layout. Default value is: 'Interactive'.
pageMode	string, optional; Sets if the report is displayed in Single page or Continuous scroll mode. The available values are: “SINGLE_PAGE” - only one page is loaded in the view port; “CONTINUOUS_SCROLL” - more than one page could be loaded in the view port; Default value is: 'CONTINUOUS_SCROLL'.
persistSession	boolean|optional. Sets whether the viewer’s client session to be persisted between the page’s refreshes(ex. postback). The session is stored in the browser’s sessionStorage and is available for the duration of the page session. A page session lasts for as long as the browser is open and survives over page reloads and restores. Opening a page in a new tab or window will cause a new session to be initiated. The viewer’s state is persisted in the global sessionStorage object under a key defined by the viewer’s id. In order to enable the correct session to be loaded on the next page reload please use the same id as in the first load. This means that if you need to persist the client session between page reloads you should set the viewer’s id (or the id of the target element) to a constant value that should not be changed dynamically during the page lifecycle. Default Value is: false;
parameters	object, optional; Allows user to defined parameters options for the report parameters. Option Description editors object, optional; Allows user to defined editors type for the report parameters. The available editors are: singleSelect (string, optional) - defineds the editor type for the single select parameters. The available values are: “COMBO_BOX” - uses Kendo UI ComboBox widget as an editor; “LIST_VIEW” - uses Kendo UI ListView widget as an editor; Default value is: 'LIST_VIEW' multiSelect (string, optional) - defineds the editor type for the multi select parameters. The available values are: “COMBO_BOX” - uses Kendo UI MultiSelect widget as an editor; “LIST_VIEW” - uses Kendo UI ListView widget as an editor; Default value is: 'LIST_VIEW'
parameterEditors	array, optional; Allows user to defined custom editors for the report parameters.
authenticationToken	string, optional; If provided, a Bearer token will be set in the Authorization header for every request to the REST service.
printMode	string, optional. Specifies how the viewer should print reports. The available values are: “AUTO_SELECT” - specifies that the viewer should automatically decide which option for printing to use depending on browser's version and whether the PDF plug-in is available or not. This is the default value; “FORCE_PDF_FILE” - specifies that the document for printing will be downloaded as a file (in PDF format with a special 'print' script enabled); “FORCE_PDF_PLUGIN” - specifies that the viewer should always use the PDF plug-in;
selector	string, optional. A selector used in conjunction with the data- attributes. Whenever a command is attached to an element outside of the report viewer via the data-attributes this selector must be provided.
disabledButtonClass	string, optional. A class used in conjunction with the data- attributes. Whenever a command is in the disabled state this class will be added to the respective button.
checkedButtonClass	string, optional. A class used in conjunction with the data- attributes. Whenever a command is in the checked state this class will be added to the respective button.
enableAccessibility	boolean, optional. Determines whether the viewer should provide support for accessibility features. You can find more detailed information here. Default value: false;
parametersAreaVisible	boolean|optional. Determines whether the viewer's parameters area is displayed if any parameter editor exists. Default value: true;
documentMapVisible	boolean|optional. Determines whether the viewer's document map is displayed if any bookmark is defined. Default value: true;
parametersAreaPosition	string, optional. Specifies where the Parameters Area should be displayed The available values are: “RIGHT” “TOP” “LEFT” “BOTTOM” Default value: RIGHT;
documentMapAreaPosition	string, optional. Specifies where the Document Map should be displayed The available values are: “RIGHT” “LEFT” Default value: LEFT;
searchMetadataOnDemand	boolean, optional. Determines whether the search metadata will be delivered on demand (true) or by default (false). Default value: false;
initialPageAreaImageUrl	string, optional. The image URL for the PageArea background image. Used only when the parameter values are missing or invalid. The image should be in PNG, GIF, or JPG file format.