[]
DEMOS DOCS API
DOWNLOAD NEED HELP? BOOK DEMO
(Showing Draft Content)

ViewerBase Class

ViewerBase Class

Base class for all the viewer controls.

Heirarchy

Constructors

Properties

Methods

Events

Constructors

constructor

  • new ViewerBase(element: any, options?: any): ViewerBase

  • Initializes a new instance of the ViewerBase class.

    Parameters

    • element: any

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

    • Optional options: any

      JavaScript object containing initialization data for the control.

    Returns ViewerBase

Properties

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.

hostElement

hostElement: HTMLElement

Gets the DOM element that is hosting the control.

isDisabled

isDisabled: boolean

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

Disabled controls cannot get mouse or keyboard events.

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.

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.

pageIndex

pageIndex: number

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

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.

zoomFactor

zoomFactor: number

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

zoomMode

zoomMode: ZoomMode

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

Static controlTemplate

controlTemplate: string

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

Methods

addEventListener

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

    Parameters

    • target: EventTarget

      Target element for the event.

    • type: string

      String that specifies the event.

    • fn: any

      Function to execute when the event occurs.

    • Optional capture: boolean

      Whether the listener should be handled by the control before it is handled by the target element.

    • Optional passive: boolean

      Indicates that the handler will never call preventDefault().

    Returns void

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

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(shouldInvalidate?: boolean): void

  • Resumes notifications suspended by calls to beginUpdate.

    Parameters

    • Optional shouldInvalidate: boolean

      should invalidate the control. Default value for this parameter is true.

    Returns 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

  • Moves to the page at the specified index.

    Parameters

    • index: number

      Index (0-base) of the page to move to.

    Returns IPromise

    An wijmo.viewer.IPromise object with current page index.

onBeforeSendRequest

onFullScreenChanged

onGotFocus

onInvalidInput

onLostFocus

onMouseModeChanged

onPageIndexChanged

onPageLoaded

onQueryLoadingData

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

refresh

  • refresh(fullUpdate?: boolean): void

  • Refreshes the control.

    Parameters

    • Optional fullUpdate: boolean

      Whether to update the control layout as well as the content.

    Returns void

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

  • Shows the page setup dialog.

    Returns 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

  • Scales the current page to fit the width of the view panel.

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