Skip to content

Latest commit

 

History

History
271 lines (212 loc) · 8.3 KB

viewer-render.component.md

File metadata and controls

271 lines (212 loc) · 8.3 KB
Raw
Title Added Status Last reviewed
Viewer Render component
v6.0.0
Active
2022-11-25

Viewer render component

Displays content from an ACS repository.

See it live: Viewer Quickstart

Contents

Basic usage

Using with file url:

<adf-viewer-render 
    [overlayMode]="true" 
    [urlFile]="'filename.pdf'">
</adf-viewer-render>

Using with file Blob:

<adf-viewer-render 
    [overlayMode]="true" 
    [blobFile]="myBlobVar">
</adf-viewer-render>

Class members

Properties

Name Type Default value Description
allowFullScreen boolean true Toggles the 'Full Screen' feature.
allowThumbnails boolean true Toggles PDF thumbnails.
blobFile Blob Loads a Blob File
fileName string Override Content filename.
isLoading boolean false Override loading status
mimeType string MIME type of the file content (when not determined by the filename extension).
readOnly boolean true Enable when where is possible the editing functionalities
thumbnailsTemplate TemplateRef<any> null The template for the pdf thumbnails.
tracks Track[] [] media subtitles for the media player
urlFile string "" If you want to load an external file that does not come from ACS you can use this URL to specify where to load the file from.
viewerTemplateExtensions TemplateRef<any> null Template containing ViewerExtensionDirective instances providing different viewer extensions based on supported file extension.
nodeId string null Identifier of a node opened by a viewer.

Events

Name Type Description
close EventEmitter<boolean> Emitted when the img is submitted in the img viewer.
extensionChange EventEmitter<string> Emitted when the filename extension changes.
submitFile EventEmitter<Blob> Emitted when the img is submitted in the img viewer.

Keyboard shortcuts

Name Description
Esc Close the viewer (overlay mode only).
Left Invoke 'Navigate before' action.
Right Invoke 'Navigate next' action.
Ctrl+F Activate full-screen mode.

Details

The component controller class implementation might look like the following:

export class OverlayViewerComponent {

    @Input()
    showViewer: boolean = false;

    nodeId: string;

    showPreview(event) {
        if (event.value.entry.isFile) {
            this.nodeId = event.value.entry.id;
            this.showViewer = true;
        }
    }
}

Custom file parameters

You can provide custom file parameters, for example a value for the mimeType or displayName when using URL values that have no file names or extensions:

<adf-viewer-render
    [displayName]="fileName"
    [allowGoBack]="false"
    [mimeType]="mimeType"
    [urlFile]="fileUrl">
</adf-viewer-render>

Supported file formats

The Viewer render component consists of separate Views that handle particular file types or type families based on either a file extension or a mime type:

  • PDF View
    • application/pdf
    • *.pdf
  • Image View
    • image/png
    • image/jpeg
    • image/gif
    • image/bmp
    • image/svg+xml
    • *.png
    • *.jpg
    • *.jpeg
    • *.gif
    • *.bpm
    • *.svg
  • Text View
    • text/plain
    • text/csv
    • text/xml
    • text/html
    • application/x-javascript
    • *.txt
    • *.xml
    • *.js
    • *.html
    • *.json
    • *.ts
  • Media View
    • video/mp4
    • video/webm
    • video/ogg
    • audio/mpeg
    • audio/ogg
    • audio/wav
    • *.wav
    • *.mp4
    • *.mp3
    • *.webm
    • *.ogg

Configuring PDF.js library

Configure your webpack-enabled application with the PDF.js library as follows.

  1. Install pdfjs-dist
npm install pdfjs-dist
  1. Update vendors.ts by appending the following code. This will enable the Viewer render component and compatibility mode for all browsers. It will also configure the web worker for the PDF.js library to render PDF files in the background:
// PDF.js
require('pdfjs-dist/web/compatibility.js');
const pdfjsLib = require('pdfjs-dist');
pdfjsLib.PDFJS.workerSrc = './pdf.worker.js';
require('pdfjs-dist/web/pdf_viewer.js');
  1. Update the plugins section of the webpack.common.js file with the following lines:
new CopyWebpackPlugin([
    ...
    {
        from: 'node_modules/pdfjs-dist/build/pdf.worker.js',
        to: 'pdf.worker.js'
    }
])

The Viewer render component should now be able to display PDF files.

Extending the Viewer

Internal extension mechanism

The Viewer supports dynamically-loaded viewer preview extensions, to know more about it Preview Extension component. This

Code extension mechanism

You can define your own custom handler to override supported file formats or handle other file formats that are not yet supported by the Viewer render component. In order to do that first you need to define a template containing at least one adf-viewer-extension:

<ng-template #viewerExtensions>
    <adf-viewer-extension [supportedExtensions]="['xls','xlsx']" #extension>
        <ng-template let-urlFileContent="urlFileContent">
            <my-custom-xls-component 
                urlFileContent="urlFileContent">
            </my-custom-xls-component>
        </ng-template>
    </adf-viewer-extension>

    <adf-viewer-render-extension [supportedExtensions]="['txt']" #extension>
        <ng-template let-urlFileContent="urlFileContent" >               
            <my-custom-txt-component 
                urlFileContent="urlFileContent">
            </my-custom-txt-component>
        </ng-template>
    </adf-viewer-render-extension>
</ng-template>

Next in your component you need to get a reference of created template

@ViewChild('viewerExtensions')
viewerTemplateExtensions: TemplateRef<any>;

and pass it via viewerTemplateExtensions input:

<adf-viewer-render>
    ...
    [viewerTemplateExtensions]="viewerTemplateExtensions"
</adf-viewer-render>

Custom layout

The Viewer render component lets you transclude custom content in several different places as explained in the sections below.

Custom zoom scaling

You can set a default zoom scaling value for pdf viewer by adding the following code in app.config.json. Note: For the pdf viewer the value has to be within the range of 25 - 1000.

"adf-viewer-render": { "pdf-viewer-scaling": 150 }

In the same way you can set a default zoom scaling value for the image viewer by adding the following code in app.config.json.

"adf-viewer-render": { "image-viewer-scaling": 150 }

By default the viewer's zoom scaling is set to 100%.

See also