Interface IDocumentView

Interface for DocumentView

interface IDocumentView {
    documentView: IDocumentViewModel;
    newDocumentEvent: Observable<IDocumentViewModel>;
    closeDocument(): Promise<boolean>;
    destroy(): void;
    exportFile(exportFileAs?: ExportFileAs): Promise<IExportFileResponse>;
    getContainer(): HTMLElement;
    getFileInputElement(): HTMLInputElement;
    mount(container: HTMLElement, shadowRoot: ShadowRoot): void;
    openBlank(
        data?: ICreateNewDocumentData,
        layout?: DocumentViewModeEnum,
        pageView?: PdfPageView,
    ): Promise<IDocumentViewModel>;
    openFile(
        file: File,
        layout?: DocumentViewModeEnum,
        pageView?: PdfPageView,
    ): Promise<IDocumentViewModel>;
    setPendingOpenInSidePane(value: boolean): void;
    setViewerWrapperCleanup(cleanup: () => void): void;
}

Index

Properties

documentView newDocumentEvent

Methods

closeDocument destroy exportFile getContainer getFileInputElement mount openBlank openFile setPendingOpenInSidePane setViewerWrapperCleanup?

Properties

documentView

documentView: IDocumentViewModel

newDocumentEvent

newDocumentEvent: Observable<IDocumentViewModel>

Methods

closeDocument

closeDocument(): Promise<boolean>
Returns Promise<boolean>
- Defined in document-view/document-view.element.ts:92

destroy

destroy(): void
Returns void
- Defined in document-view/document-view.element.ts:96

exportFile

exportFile(exportFileAs?: ExportFileAs): Promise<IExportFileResponse>
Parameters
- OptionalexportFileAs: ExportFileAs
Returns Promise<IExportFileResponse>
- Defined in document-view/document-view.element.ts:91

getContainer

getContainer(): HTMLElement
Returns HTMLElement
- Defined in document-view/document-view.element.ts:99

getFileInputElement

getFileInputElement(): HTMLInputElement
Returns HTMLInputElement
- Defined in document-view/document-view.element.ts:102

mount

mount(container: HTMLElement, shadowRoot: ShadowRoot): void
Parameters
- container: HTMLElement
- shadowRoot: ShadowRoot
Returns void
- Defined in document-view/document-view.element.ts:95

openBlank

openBlank(
    data?: ICreateNewDocumentData,
    layout?: DocumentViewModeEnum,
    pageView?: PdfPageView,
): Promise<IDocumentViewModel>
Opens a blank document and returns a promise that resolves to the document view model
Parameters
- Optionaldata: ICreateNewDocumentData
  Optional data for creating a new document
- Optionallayout: DocumentViewModeEnum
  Optional layout mode for the document view
- OptionalpageView: PdfPageView
  Optional page view mode
Returns Promise<IDocumentViewModel>
Promise that resolves to the document view model
- Defined in document-view/document-view.element.ts:90

openFile

openFile(
    file: File,
    layout?: DocumentViewModeEnum,
    pageView?: PdfPageView,
): Promise<IDocumentViewModel>
Opens a PDF file and returns a promise that resolves to the document view model
Parameters
- file: File
  File to open. If not provided, uses the file input element
- Optionallayout: DocumentViewModeEnum
  Optional layout mode for the document view
- OptionalpageView: PdfPageView
  Optional page view mode
Returns Promise<IDocumentViewModel>
Promise that resolves to the document view model
- Defined in document-view/document-view.element.ts:82

setPendingOpenInSidePane

setPendingOpenInSidePane(value: boolean): void
Signal that the next file open should target the active side-by-side pane
Parameters
- value: boolean
Returns void
- Defined in document-view/document-view.element.ts:104

`Optional`setViewerWrapperCleanup

setViewerWrapperCleanup(cleanup: () => void): void
Parameters
- cleanup: () => void
Returns void
- Defined in document-view/document-view.element.ts:107