Skip to content

Commit 99f6639

Browse files
Update report-viewer-initialization.md (#1956)
* Update report-viewer-initialization.md * Update options.md * Update options.md * Update options.md * Update report-viewer-initialization.md * Update options.md * Apply suggestions from code review Co-authored-by: Petar Todorov <[email protected]> --------- Co-authored-by: Petar Todorov <[email protected]>
1 parent 094c4a9 commit 99f6639

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

embedding-reports/display-reports-in-applications/web-application/angular-report-viewer/api-reference/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export class ReportViewerComponent implements AfterViewInit {
8787
| __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.|
8888
| __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.|
8989
| __enableAccessibility__ | *boolean*, *optional*. Determines whether the viewer should provide support for accessibility features. You can find more detailed information [here]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/accessibility%}). <br/>Default value: *false*;|
90-
| __parametersAreaVisible__ | *boolean* | *optional*. Determines whether the viewer's parameters area is displayed if any parameter editor exists. <br/>Default value: *true*;|
90+
| __parametersAreaVisible__ | *boolean* | *optional*. Determines whether the viewer's parameters area is initially displayed if any parameter editor exists. The user can expand the parameters area even if it is hidden initially, either through the splitter control or from the toolbar menu. Additionally, the property determines only whether the element, with the *visible* report parameters, will be visible on the page. Even when the setting is **False**, and the parameters area is not visible on the page, it would still be rendered to the [Document Object Model (DOM)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model). For that reason, if you have a report parameter that contains sensitive information that must not be accessible publicly, set its [Visible](/api/Telerik.Reporting.ReportParameter#Telerik_Reporting_ReportParameter_Visible) property to **False** instead. This way, the report parameter will not be rendered in the DOM regardless of the __parametersAreaVisible__ setting. <br/>Default value: *true*;|
9191
| __documentMapVisible__ | *boolean* | *optional*. Determines whether the viewer's document map is displayed if any bookmark is defined. <br/>Default value: *true*;|
9292
| __parametersAreaPosition__ | *string*, *optional*. Specifies where the Parameters Area should be displayed <br/>The available values are: <ul><li>*“RIGHT”*</li> <li>*“TOP”*</li> <li>*“LEFT”*</li> <li>*“BOTTOM”*</li></ul>Default value: *RIGHT*;|
9393
| __documentMapAreaPosition__ | *string*, *optional*. Specifies where the Document Map should be displayed <br/>The available values are: <ul><li>*“RIGHT”*</li> <li>*“LEFT”*</li></ul>Default value: *LEFT*;|

embedding-reports/display-reports-in-applications/web-application/html5-report-viewer/api-reference/report-viewer-initialization.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,19 @@ The Telerik HTML5 Report Viewer is a jQuery plugin - `jQuery.fn.telerik_ReportVi
4040
| __printMode__ | *string*, *optional*; Specifies whether the viewer will use the PDF plug-in of the browser for printing, or will directly export to a PDF file containing a special 'print' script. <br/>The available values are: <ul><li>*"AUTO_SELECT"* - the widget will try to automatically determine whether to export the report document or use the browser's PDF plug-in. First, the viewer widget tries to use the PDF plug-in of the browser for printing. When it is not available or not supported, the widget falls back to exporting to a PDF file containing a special 'print' script;</li> <li>*"FORCE_PDF_PLUGIN"* - the widget will always try to use the PDF plug-in of the browser. If the browser doesn't have a PDF plug-in or it does not support the 'print' script nothing will happen;</li> <li>*"FORCE_PDF_FILE"* - the widget will always export the report document to a PDF file with a special 'print' script;</li></ul>Default value is: *"AUTO_SELECT"*.|
4141
| __parametersAreaPosition__ | *string*, *optional*. Specifies where the Parameters Area should be displayed. <br/>The available values are: <ul><li>*“RIGHT”* </li> <li>*“TOP”* </li> <li>*“LEFT”* </li> <li>*“BOTTOM”*</li></ul>Default value: *RIGHT*;|
4242
| __documentMapAreaPosition__ | *string*, *optional*. Specifies where the Document Map should be displayed. <br/>The available values are: <ul><li>*“RIGHT”* </li> <li>*“LEFT”*</li></ul>Default value: *LEFT*;|
43-
| __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](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage) 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.<br/>The viewer’s state is persisted in the global sessionStorage object under a key defined by the viewer’s __id__. 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.<br/>Default Value is: *false*;|
44-
| __parameters__ | *object*, *optional*; Allows the user to define parameter options for the report parameters. <br/><table><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><strong>editors</strong></td><td><em>object</em>, <em>optional</em>; Allows the user to define editors type for the report parameters. <br/>The available editors are: <ul><li>__singleSelect__ (*string*, *optional*) - defines the editor type for the single select parameters. <br/>The available values are: <ul><li>*“COMBO_BOX”* - uses [Kendo UI ComboBox](https://docs.telerik.com/kendo-ui/api/javascript/ui/combobox) widget as an editor;</li> <li>*“LIST_VIEW”* - uses [Kendo UI ListView](https://docs.telerik.com/kendo-ui/api/javascript/ui/listview) widget as an editor;</li></ul>Default value is: *'LIST_VIEW'*</li> <li>__multiSelect__ (*string*, *optional*) - defineds the editor type for the multi select parameters.<br/>The available values are: <ul><li>*“COMBO_BOX”* - uses [Kendo UI MultiSelect](https://docs.telerik.com/kendo-ui/api/javascript/ui/multiselect) widget as an editor;</li> <li>*“LIST_VIEW”* - uses [Kendo UI ListView](https://docs.telerik.com/kendo-ui/api/javascript/ui/listview) widget as an editor;</li></ul>Default value is: *'LIST_VIEW'*</li></ul><pre><code>$("#reportViewer1").telerik_ReportViewer({...parameters: {editors: {multiSelect: telerikReportViewer.ParameterEditorTypes.COMBO_BOX,}}});</code></pre></td></tr></tbody></table>|
43+
| __persistSession__ | *boolean*, *optional*. Sets whether the viewer’s client session is to be persisted between the page’s refreshes(ex. postback). The session is stored in the browser’s [sessionStorage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage) 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.<br/>The viewer’s state is persisted in the global sessionStorage object under a key defined by the viewer’s __id__. 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.<br/>Default Value is: *false*;|
44+
| __parameters__ | *object*, *optional*; Allows the user to define parameter options for the report parameters. <br/><table><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><strong>editors</strong></td><td><em>object</em>, <em>optional</em>; Allows the user to define editor types for the report parameters. <br/>The available editors are: <ul><li>__singleSelect__ (*string*, *optional*) - defines the editor type for the single select parameters. <br/>The available values are: <ul><li>*“COMBO_BOX”* - uses [Kendo UI ComboBox](https://docs.telerik.com/kendo-ui/api/javascript/ui/combobox) widget as an editor;</li> <li>*“LIST_VIEW”* - uses [Kendo UI ListView](https://docs.telerik.com/kendo-ui/api/javascript/ui/listview) widget as an editor;</li></ul>Default value is: *'LIST_VIEW'*</li> <li>__multiSelect__ (*string*, *optional*) - defineds the editor type for the multi select parameters.<br/>The available values are: <ul><li>*“COMBO_BOX”* - uses [Kendo UI MultiSelect](https://docs.telerik.com/kendo-ui/api/javascript/ui/multiselect) widget as an editor;</li> <li>*“LIST_VIEW”* - uses [Kendo UI ListView](https://docs.telerik.com/kendo-ui/api/javascript/ui/listview) widget as an editor;</li></ul>Default value is: *'LIST_VIEW'*</li></ul><pre><code>$("#reportViewer1").telerik_ReportViewer({...parameters: {editors: {multiSelect: telerikReportViewer.ParameterEditorTypes.COMBO_BOX,}}});</code></pre></td></tr></tbody></table>|
4545
| __parameterEditors__ | *array*, *optional*; Allows the user to define custom editors for the report parameters.|
46-
| __authenticationToken__ | *string*, *optional*; If provided, a *Bearer* token will be set in the *Authorization* header for requests to the REST service. The token is not sent only when requesting [document resources]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/documents-api/get-document-resource%}). The reason is that the resources like images are referenced with relative URLs in the HTML of the report document, hence the requests for them are made by the browser.|
46+
| __authenticationToken__ | *string*, *optional*; If provided, a *Bearer* token will be set in the *Authorization* header for requests to the REST service. The token is not sent only when requesting [document resources]({%slug telerikreporting/using-reports-in-applications/host-the-report-engine-remotely/telerik-reporting-rest-services/rest-api-reference/documents-api/get-document-resource%}). The reason is that resources like images are referenced with relative URLs in the HTML of the report document, hence the requests for them are made by the browser.|
4747
| __enableAccessibility__ | *boolean*, *optional*. Determines whether the viewer should provide support for accessibility features. You can find more detailed information in the article [Accessibility Overview]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/accessibility%}). <br/>Default value: *false*;|
48-
| __parametersAreaVisible__ | *boolean*, *optional*. Determines whether the viewer's parameters area is displayed if any parameter editor exists. <br/>Default value: *true*;|
48+
| __parametersAreaVisible__ | *boolean*, *optional*. Determines whether the viewer's parameters area is initially displayed if any parameter editor exists. The user can expand the parameters area even if it is hidden initially, either through the splitter control or from the toolbar menu. Additionally, the property determines only whether the element, with the *visible* report parameters, will be visible on the page. Even when the setting is **False**, and the parameters area is not visible on the page, it would still be rendered to the [Document Object Model (DOM)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model). For that reason, if you have a report parameter that contains sensitive information that must not be accessible publicly, set its [Visible](/api/Telerik.Reporting.ReportParameter#Telerik_Reporting_ReportParameter_Visible) property to **False** instead. This way, the report parameter will not be rendered in the DOM regardless of the __parametersAreaVisible__ setting. <br/>Default value: *true*;|
4949
| __documentMapVisible__ | *boolean*, *optional*. Determines whether the viewer's document map is displayed if any bookmark is defined. <br/>Default value: *true*;|
5050
| __searchMetadataOnDemand__ | *boolean*, *optional*. Determines whether the search metadata will be delivered on demand __(true)__ or by default __(false)__. <br/>Default value: *false*;|
5151
| __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.|
5252
| __keepClientAlive__ | *boolean*, *optional*. Determines whether the client will be kept alive. When set to true expiration of the client will be prevented by continually sending a request to the server, determined by the Reporting REST service's __ClientSessionTimeout__. <br/>Default Value is: *true*;|
5353
| __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.|
54-
| __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.|
55-
| __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.|
54+
| __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.|
55+
| __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.|
5656
| __ready__ | *function();* *optional;* A callback function that will be called when the viewer content has been loaded from the template and is ready to display reports or perform any other operations on it. The function is executed in the context of the ReportViewer object that is available through the __this__ object.|
5757
| __exportBegin__ | *function(e, args);optional;* A callback function that will be called before starting the report export command.|
5858
| __exportEnd__ | *function(e, args);optional;* A callback function that will be called when the exported document is ready for download, but before the actual downloading.|

0 commit comments

Comments
 (0)