Defines the ReportViewer control for displaying the FlexReport or SSRS report.
The serviceUrl property indicates the url of C1 Web API which provides report services. The report services use C1FlexReport to process a FlexReport, and use C1SSRSDocumentSource and C1PdfDocumentSource to process an SSRS report.
Here is a sample of how to show a FlexReport:
import { ReportViewer } from '@mescius/wijmo.viewer';
var reportViewer = new ReportViewer('#reportViewer');
reportViewer.serviceUrl = 'http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report';
reportViewer.filePath = 'ReportsRoot/Formatting/AlternateBackground.flxr';
reportViewer.reportName = 'AlternateBackground';
Here is a sample of how to show an SSRS report:
import { ReportViewer } from '@mescius/wijmo.viewer';
var reportViewer = new ReportViewer('#reportViewer');
reportViewer.serviceUrl = 'http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report';
reportViewer.filePath = 'c1ssrs/AdventureWorks/Company Sales';
constructor(element: any, options?: any): ReportViewer
Initializes a new instance of the ReportViewer class.
The DOM element that will host the control, or a CSS selector for the host element (e.g. '#theCtrl').
JavaScript object containing initialization data for the control.
Gets or sets the template used to instantiate the viewer controls.
Gets or sets the full path to the document on the server.
The path starts with the key of a provider which is registered at server for locating specified document.
Gets or sets a value indicating whether the viewer is under full screen mode.
Gets the DOM element that is hosting the control.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
Gets or sets a value indicating the mouse behavior.
The default is SelectTool which means clicking and dragging the mouse will select the text.
Gets the index of the page which is currently displayed in the view panel.
Gets or sets a value indicating whether the content should be represented as a set of fixed sized pages.
The default value is null which means using paginated mode for a FlexReport and non-paginaged mode for an SSRS report.
Gets or sets a dictionary of {name: value} pairs that describe the parameters used to run the report.
This property is useful if the report requires that certain parameters (for example, the hidden ones) to be passed during the initial stage.
reportViewer.parameters = {
'CustomerID': 'ALFKI'
};
Gets or sets the report name.
For FlexReport, sets it with the report name defined in the FlexReport definition file. For SSRS report, leave it as empty string. The SSRS report path is specified by the filePath property.
Gets or sets an object containing request headers to be used when sending or requesting data.
The most typical use for this property is in scenarios where authentication is required. For example:
viewer.requestHeaders = {
Authorization: 'Bearer ' + appAuthService.getToken();
};
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets the address of C1 Web API service.
For example, http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report
Gets or sets a value of the **tabindex** attribute associated with the control.
**tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.
Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.
Gets or sets the threshold to switch between mobile and PC template.
Default value is 767px. If width of control is smaller than thresholdWidth, mobile template will be applied. If width of control is equal or greater than thresholdWidth, PC template will be applied. If thresholdWidth is set to 0, then only PC template is applied and if it's set to a large number e.g. 9999, then only mobile template is applied.
Gets or sets a value indicating how to show the document pages.
Gets or sets a value indicating the current zoom factor to show the document pages.
Gets or sets a value indicating the current zoom mode to show the document pages.
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
Adds an event listener to an element owned by this Control.
The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).
Failing to remove event listeners may cause memory leaks.
The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.
For details on passive event listeners, please see Improving scrolling performance with passive listeners.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
Applies the template to a new instance of a control, and returns the root element.
This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.
For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.
this.applyTemplate('wj-control wj-inputnumber', templateString, {
_tbx: 'input',
_btnUp: 'btn-inc',
_btnDn: 'btn-dec'
}, 'input');
```
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
deferUpdate(fn: Function): void
Executes a function within a beginUpdate/endUpdate block.
The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.
Function to be executed.
dispose(): void
Disposes of the control by removing its association with the host element.
The dispose method automatically removes any event listeners added with the addEventListener method.
Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(): void
Resumes notifications suspended by calls to beginUpdate.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
getReportNames(serviceUrl: string, reportFilePath: string, httpHandler?: IHttpRequestHandler): IPromise
Gets the report names defined in the specified FlexReport definition file.
The address of C1 Web API service.
The full path to the FlexReport definition file.
The HTTP request handler. This parameter is optional.
getReports(serviceUrl: string, path: string, data?: any, httpHandler?: IHttpRequestHandler): IPromise
Gets the catalog items in the specified folder path.
You can get all items under the folder path by passing the data parameter as: 1) A true value. 2) An object which has the "recursive" property with true value.
The address of C1 Web API service.
The folder path. The path to the FlexReport definition file will be treated as a folder path.
The request data sent to the report service, or a boolean value indicates whether getting all items under the path.
The HTTP request handler. This parameter is optional.
getTemplate(): string
Gets the HTML template used to create instances of the control.
This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).
initialize(options: any): void
Initializes the control by copying the properties from a given object.
This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.
For example:
grid.initialize({
itemsSource: myList,
autoGenerateColumns: false,
columns: [
{ binding: 'id', header: 'Code', width: 130 },
{ binding: 'name', header: 'Name', width: 60 }
]
});
// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// etc.
The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
invalidateAll(e?: HTMLElement): void
Invalidates all Wijmo controls contained in an HTML element.
Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.
If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
moveToPage(index: number): IPromise
Moves to the page at the specified index.
Index (0-base) of the page to move to.
onBeforeSendRequest(e: RequestEventArgs): void
Raises the beforeSendRequest event.
The RequestEventArgs object.
onFullScreenChanged(e?: EventArgs): void
Raises the fullScreenChanged event.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onInvalidInput(e: CancelEventArgs): void
Raises the invalidInput event.
If the event handler cancels the event, the control will keep the invalid input and the focus.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onMouseModeChanged(e?: EventArgs): void
Raises the mouseModeChanged event.
onPageIndexChanged(e?: EventArgs): void
Raises the pageIndexChanged event.
onPageLoaded(e: PageLoadedEventArgs): void
Raises the pageLoaded event.
The PageLoadedEventArgs object.
onQueryLoadingData(e: QueryLoadingDataEventArgs): void
Raises the queryLoadingData event.
The QueryLoadingDataEventArgs object that contains the loading data.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
onViewModeChanged(oldValue: ViewMode, newValue: ViewMode): void
Raises the viewModeChanged event.
onZoomFactorChanged(e?: EventArgs): void
Raises the zoomFactorChanged event.
onZoomModeChanged(e?: EventArgs): void
Raises the zoomModeChanged event.
refresh(fullUpdate?: boolean): void
Refreshes the control.
Whether to update the control layout as well as the content.
refreshAll(e?: HTMLElement): void
Refreshes all Wijmo controls contained in an HTML element.
This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
reload(): void
Reloads the document.
This is useful for force reloading and rerendering the document.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
showPageSetupDialog(): void
Shows the page setup dialog.
zoomToView(): void
Scales the current page to show the whole page in view panel.
zoomToViewWidth(): void
Scales the current page to fit the width of the view panel.
Occurs before every request sent to the server.
The event allows you to modify request options like URL, headers, data and even the request method, before sending them to the server. The event passes an argument of the RequestEventArgs type, whose properties have the same meaning and structure as the parameters of the httpRequest method, and can be modified to update the request attributes.
For example, you can put an authentication token to the 'Authorization' header:
viewer.beforeSendRequest.addHandler((s, e) => {
e.settings.requestHeaders.Authorization = 'Bearer ' + appAuthService.getToken();
});
If the URL is used to induce an HTTP request that is executed by the browser automatically (for example, if the URL is used as a parameter to the window.open() function, or as a HTML link), then the e.settings argument will be null.
Occurs after the full screen mode is changed.
Occurs when invalid input is detected.
Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.
If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.
If the event is not canceled, the control will ignore the invalid input and will retain the original content.
Occurs after the mouse mode is changed.
Occurs after the page index is changed.
Occurs when the next page has been loaded from the server, and its SVG has been rendered.
Occurs when querying the request data sent to the service before loading the document.
Occurs after the control has refreshed its contents.
Occurs when the control is about to refresh its contents.
Occurs after the view mode is changed.
Occurs after the zoom factor is changed.
Occurs after the zoom mode is changed.