@snowbound/virtualviewer

VirtualViewer for Angular

Installation

To install this library, run:

$ npm install @snowbound/virtualviewer --save

Consuming @snowbound/virtualviewer

To use the VirtualViewerComponent you must import VirtualViewerModule. When importing you can also configure base VirtualViewer settings, such as the URL for this component to connect to VirtualViewer (which by default is http://localhost:8080/virtualviewer).

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

//Import the base config object VirtualViewerConfig if you wish to change default configuration
import { VirtualViewerModule, VirtualViewerConfig } from '@snowbound/virtualviewer';

//To change configuration, create a VirtualViewerConfig with your desired configuration
const myVirtualViewerConfig: VirtualViewerConfig = {
    baseUrl: "http://my-virtual-viewer-url:8080";
}

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,

    //import VirtualViewer
    //VirtualViewerConfig can be provided as an optional parameter
    VirtualViewerModule.forRoot(myVirtualViewerConfig);
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Using VirtualViewerComponent

The VirtualViewerComponent selector is <snbd-virtualviewer> - this component will create a frame containing VirtualViewer. If you wish to also open a document, you can provide documentId and (optionally) clientInstanceId inputs:

<snbd-virtualviewer [documentId]="MyDocument.pdf" [clientInstanceId]="clientInstanceId"></snbd-virtualviewer>