Interops
Angular2
Viewer
5.20231.904
wijmo.angular2.viewer Class WjReportViewer Wijmo API Class

WjReportViewer Class

Angular 2 component for the wijmo.viewer.ReportViewer control.

Use the wj-report-viewer component to add ReportViewer controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

The WjReportViewer component is derived from the ReportViewer control and inherits all its properties, events and methods.

Heirarchy

Properties

Methods

Events

Properties

asyncBindings

asyncBindings: boolean

Allows you to override the global WjOptions.asyncBindings setting for this specific component. See the WjOptions.WjOptions.asyncBindings property description for details.

beforeSendRequestNg

beforeSendRequestNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo beforeSendRequest event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional beforeSendRequest Wijmo event name.

filePath

filePath: string

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.

fullScreen

fullScreen: boolean

Gets or sets a value indicating whether the viewer is under full screen mode.

fullScreenChangePC

fullScreenChangePC: EventEmitter<any>

This event is used to implement two-way binding to the fullScreen property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the fullScreenChange event name.

fullScreenChangedNg

fullScreenChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo fullScreenChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional fullScreenChanged Wijmo event name.

gotFocusNg

gotFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo gotFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional gotFocus Wijmo event name.

hostElement

hostElement: HTMLElement

Gets the DOM element that is hosting the control.

initialized

initialized: EventEmitter<any>

This event is triggered after the component has been initialized by Angular, that is all bound properties have been assigned and child components (if any) have been initialized.

invalidInputNg

invalidInputNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo invalidInput event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional invalidInput Wijmo event name.

isDisabled

isDisabled: boolean

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.

isInitialized

isInitialized: boolean

Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.

isTouching

isTouching: boolean

Gets a value that indicates whether the control is currently handling a touch event.

isUpdating

isUpdating: boolean

Gets a value that indicates whether the control is currently being updated.

lostFocusNg

lostFocusNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo lostFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional lostFocus Wijmo event name.

mouseMode

mouseMode: MouseMode

Gets or sets a value indicating the mouse behavior.

The default is SelectTool which means clicking and dragging the mouse will select the text.

mouseModeChangePC

mouseModeChangePC: EventEmitter<any>

This event is used to implement two-way binding to the mouseMode property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the mouseModeChange event name.

mouseModeChangedNg

mouseModeChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo mouseModeChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional mouseModeChanged Wijmo event name.

pageIndex

pageIndex: number

Gets the index of the page which is currently displayed in the view panel.

pageIndexChangedNg

pageIndexChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo pageIndexChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional pageIndexChanged Wijmo event name.

paginated

paginated: boolean

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.

parameters

parameters: any

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'
};

queryLoadingDataNg

queryLoadingDataNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo queryLoadingData event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional queryLoadingData Wijmo event name.

refreshedNg

refreshedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshed event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshed Wijmo event name.

refreshingNg

refreshingNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo refreshing event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshing Wijmo event name.

reportName

reportName: string

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.

requestHeaders

requestHeaders: any

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();
};

rightToLeft

rightToLeft: boolean

Gets a value indicating whether the control is hosted in an element with right-to-left layout.

serviceUrl

serviceUrl: string

Gets or sets the address of C1 Web API service.

For example, http://demos.componentone.com/ASPNET/c1webapi/4.0.20172.105/api/report

tabOrder

tabOrder: number

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.

thresholdWidth

thresholdWidth: number

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.

viewMode

viewMode: ViewMode

Gets or sets a value indicating how to show the document pages.

viewModeChangePC

viewModeChangePC: EventEmitter<any>

This event is used to implement two-way binding to the viewMode property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the viewModeChange event name.

viewModeChangedNg

viewModeChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo viewModeChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional viewModeChanged Wijmo event name.

wjModelProperty

wjModelProperty: string

Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is ''.

zoomFactor

zoomFactor: number

Gets or sets a value indicating the current zoom factor to show the document pages.

zoomFactorChangePC

zoomFactorChangePC: EventEmitter<any>

This event is used to implement two-way binding to the zoomFactor property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the zoomFactorChange event name.

zoomFactorChangedNg

zoomFactorChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo zoomFactorChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional zoomFactorChanged Wijmo event name.

zoomMode

zoomMode: ZoomMode

Gets or sets a value indicating the current zoom mode to show the document pages.

zoomModeChangePC

zoomModeChangePC: EventEmitter<any>

This event is used to implement two-way binding to the zoomMode property. It's triggered when the property value changes, with the event argument holding the new property value. You can bind handlers to this event in templates using the zoomModeChange event name.

zoomModeChangedNg

zoomModeChangedNg: EventEmitter<any>

Angular (EventEmitter) version of the Wijmo zoomModeChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional zoomModeChanged Wijmo event name.

Static controlTemplate

controlTemplate: string

Gets or sets the template used to instantiate the viewer controls.

Methods

applyTemplate

  • 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');

    @param classNames Names of classes to add to the control's host element. @param template An HTML string that defines the control template. @param parts A dictionary of part variables and their names. @param namePart Name of the part to be named after the host element. This determines how the control submits data when used in forms.

    Parameters

    • classNames: string
    • template: string
    • parts: Object
    • Optional namePart: string

    Returns HTMLElement

beginUpdate

  • beginUpdate(): void

containsFocus

  • containsFocus(): boolean

  • Checks whether this control contains the focused element.

    Returns boolean

created

  • created(): void

  • If you create a custom component inherited from a Wijmo component, you can override this method and perform necessary initializations that you usually do in a class constructor. This method is called in the last line of a Wijmo component constructor and allows you to not declare your custom component's constructor at all, thus preventing you from a necessity to maintain constructor parameters and keep them in synch with Wijmo component's constructor parameters.

    Returns void

deferUpdate

  • 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.

    Parameters

    • fn: Function

      Function to be executed.

    Returns void

dispose

  • 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.

    Returns void

endUpdate

  • endUpdate(): void

focus

  • focus(): void

  • Sets the focus to this control.

    Returns void

getTemplate

  • 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).

    Returns string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean

  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

initialize

  • 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.

    Parameters

    • options: any

      Object that contains the initialization data.

    Returns void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean

  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

moveToPage

onBeforeSendRequest

onFullScreenChanged

onGotFocus

onInvalidInput

onLostFocus

onMouseModeChanged

onPageIndexChanged

onPageLoaded

onRefreshed

onRefreshing

onViewModeChanged

onZoomFactorChanged

onZoomModeChanged

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean

  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

reload

  • reload(): void

  • Reloads the document.

    This is useful for force reloading and rerendering the document.

    Returns void

removeEventListener

  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

  • Removes one or more event listeners attached to elements owned by this Control.

    Parameters

    • Optional target: EventTarget

      Target element for the event. If null, removes listeners attached to all targets.

    • Optional type: string

      String that specifies the event. If null, removes listeners attached to all events.

    • Optional fn: any

      Handler to remove. If null, removes all handlers.

    • Optional capture: boolean

      Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

    Returns number

    The number of listeners removed.

showPageSetupDialog

  • showPageSetupDialog(): void

toLocaleString

  • toLocaleString(): string

  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object

  • Returns the primitive value of the specified object.

    Returns Object

zoomToView

  • zoomToView(): void

  • Scales the current page to show the whole page in view panel.

    Returns void

zoomToViewWidth

  • zoomToViewWidth(): void

Static disposeAll

  • disposeAll(e?: HTMLElement): void

  • Disposes of all Wijmo controls contained in an HTML element.

    Parameters

    • Optional e: HTMLElement

      Container element.

    Returns void

Static getControl

  • getControl(element: any): Control

  • Gets the control that is hosted in a given DOM element.

    Parameters

    • element: any

      The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Returns Control

Static getReportNames

  • Gets the report names defined in the specified FlexReport definition file.

    Parameters

    • serviceUrl: string

      The address of C1 Web API service.

    • reportFilePath: string

      The full path to the FlexReport definition file.

    • Optional httpHandler: IHttpRequestHandler

      The HTTP request handler. This parameter is optional.

    Returns IPromise

    An wijmo.viewer.IPromise object with a string array which contains the report names.

Static getReports

  • 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.

    Parameters

    • serviceUrl: string

      The address of C1 Web API service.

    • path: string

      The folder path. The path to the FlexReport definition file will be treated as a folder path.

    • Optional data: any

      The request data sent to the report service, or a boolean value indicates whether getting all items under the path.

    • Optional httpHandler: IHttpRequestHandler

      The HTTP request handler. This parameter is optional.

    Returns IPromise

    An IPromise object with an array of wijmo.viewer.ICatalogItem.

Static invalidateAll

  • 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 Control.invalidateAll method so the contained Wijmo controls will update their layout information properly.

    Parameters

    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Static refreshAll

  • 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.

    Parameters

    • Optional e: HTMLElement

      Container element. If set to null, all Wijmo controls on the page will be invalidated.

    Returns void

Events

beforeSendRequest

beforeSendRequest: Event<ViewerBase, RequestEventArgs>

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 wijmo.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.

fullScreenChanged

fullScreenChanged: Event<ViewerBase, EventArgs>

Occurs after the full screen mode is changed.

gotFocus

gotFocus: Event<Control, EventArgs>

Occurs when the control gets the focus.

invalidInput

invalidInput: Event<Control, CancelEventArgs>

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.

lostFocus

lostFocus: Event<Control, EventArgs>

Occurs when the control loses the focus.

mouseModeChanged

mouseModeChanged: Event<ViewerBase, EventArgs>

Occurs after the mouse mode is changed.

pageIndexChanged

pageIndexChanged: Event<ViewerBase, EventArgs>

Occurs after the page index is changed.

pageLoaded

pageLoaded: Event<ViewerBase, PageLoadedEventArgs>

Occurs when the next page has been loaded from the server, and its SVG has been rendered.

queryLoadingData

queryLoadingData: Event<ViewerBase, QueryLoadingDataEventArgs>

Occurs when querying the request data sent to the service before loading the document.

refreshed

refreshed: Event<Control, EventArgs>

Occurs after the control has refreshed its contents.

refreshing

refreshing: Event<Control, EventArgs>

Occurs when the control is about to refresh its contents.

viewModeChanged

viewModeChanged: Event<ViewerBase, EventArgs>

Occurs after the view mode is changed.

zoomFactorChanged

zoomFactorChanged: Event<ViewerBase, _IZoomFactorChangedEventArgs>

Occurs after the zoom factor is changed.

zoomModeChanged

zoomModeChanged: Event<ViewerBase, _IZoomModeChangedEventArgs>

Occurs after the zoom mode is changed.