PDF Web Viewer
    Preparing search index...

    Interface IDocumentViewModel

    interface IDocumentViewModel {
        maxZoomIn: number;
        minZoomOut: number;
        activeToolChanged(): Observable<ToolTypes>;
        annotationPopupShow(): Observable<
            {
                annot: Annotation;
                annotationIndex: number;
                pageIndex: number;
                viewPoint: { x: number; y: number };
            },
        >;
        contextMenuShow(): Observable<
            {
                name: ContextMenu;
                operations: number;
                position: { x: number; y: number };
            },
        >;
        doCommand(
            command: DocumentCommand,
            position?: { x: number; y: number },
        ): void;
        eSignDocumentChanged(): Observable<ESignDocument>;
        exportFile(options?: IExportFileModelOptions): Promise<void>;
        focusPageChanged(): Observable<number>;
        fontChanged(): Observable<
            { font: IFontAttributes; partialChanges?: IFontAttributes },
        >;
        getActiveTool(): ToolTypes;
        getDocument(): IDocumentModel;
        getDocumentFonts(): IFontAttributes[];
        getDocumentId(): string;
        getESignDocument(): ESignDocument;
        getFillAndSignColor(): string;
        getFocusPage(): number;
        getFont(): IFontAttributes;
        getLayout(): DocumentViewModeEnum;
        getPageAtPoint(viewPoint: { x: number; y: number }): number;
        getPagePreview(
            pageIndex: number,
            rect?: [number, number, number, number],
            zoom?: number,
            pageBox?: DrawPageBox,
        ): Promise<Uint8Array<ArrayBufferLike>>;
        getPageView(): PdfPageView;
        getParagraphAttributes(): ITextParagraphAttributes;
        getScrollPosition(bar: BLScrollBarType): number;
        getSelection(): any;
        getSelectionType(): string;
        getSystemFonts(): IFontAttributes[];
        getZoom(): number;
        goToNextPage(): void;
        goToPage(pageIndex: number): void;
        goToPrevPage(): void;
        gridChanged(): Observable<boolean>;
        highlightFormFieldsChanged(): Observable<boolean>;
        isGridEnabled(): boolean;
        isHighlightFormFieldsEnabled(): boolean;
        isRulersEnabled(): boolean;
        layoutChanged(): Observable<DocumentViewModeEnum>;
        mapPointToDevice(pageIndex: number, point: PointModel): PointModel;
        mapPointToPage(
            pageIndex: number,
            point: { x: number; y: number },
        ): PointModel;
        mapQuadToDevice(pageIndex: number, quad: QuadModel): QuadModel;
        mapQuadToPage(pageIndex: number, quad: QuadModel): QuadModel;
        mapRectToDevice(pageIndex: number, rect: RectModel): RectModel;
        mapRectToPage(pageIndex: number, rect: RectModel): RectModel;
        mapSizeToDevice(pageIndex: number, size: SizeModel): SizeModel;
        mapSizeToPage(pageIndex: number, size: SizeModel): SizeModel;
        notifyESignDocumentChanged(): void;
        onSearchResults(): Observable<CaretRange[]>;
        ownerPasswordDialogShow(): Observable<void>;
        pagesRotation(): Observable<number>;
        pageViewChanged(): Observable<PdfPageView>;
        paragraphAttributesChanged(): Observable<
            { attributes: ITextParagraphAttributes; fromCaret: boolean },
        >;
        print(): Promise<void>;
        resetActiveTool(): void;
        resetSelection(): void;
        rotate(rotate: number): void;
        rulersChanged(): Observable<boolean>;
        saveDocument(options?: IExportFileModelOptions): Promise<boolean>;
        saveDocumentAs(
            options?: IExportFileModelOptions,
            target?: ISaveAsTarget,
        ): Promise<boolean>;
        saveOriginTarget(): { item: IFileItem; provider: IFilesProvider };
        scrollPositionChanged(): Observable<{ bar: BLScrollBarType; pos: number }>;
        search(text: string, flags: PageTextSearchFlags): Promise<void>;
        selectionChanged(): Observable<string>;
        selectText(range: CaretRange): Promise<void>;
        setActiveTool(tool: ToolTypes, params?: any): void;
        setDefaultMargins(): void;
        setESignDocument(
            doc: ESignDocument,
            validate?: { fileType: boolean; maxSize?: number; security: boolean },
        ): boolean;
        setFillAndSignColor(color: string): void;
        setFont(font: IFontAttributes, partial?: boolean): void;
        setGridEnabled(enabled: boolean): void;
        setHighlightFormFieldsEnabled(enable: boolean): void;
        setLayout(layoutName: DocumentViewModeEnum): void;
        setLayoutMargins(
            marginVertical: number,
            marginHorizontal: number,
            pagesVerticalMargin: number,
            pagesHorizontalMargin: number,
        ): void;
        setPageView(pageView: PdfPageView): void;
        setParagraphAttributes(attributes: ITextParagraphAttributes): void;
        setRulersEnabled(enabled: boolean): void;
        setScrollPosition(bar: BLScrollBarType, pos: number): void;
        setZoom(
            zoom: number,
            viewMode?: string,
            point?: { x: number; y: number },
        ): void;
        stopSearch(): void;
        zoomChanged(): Observable<number>;
        zoomIn(): void;
        zoomOut(): void;
    }
    Index

    Properties

    maxZoomIn: number
    minZoomOut: number

    Methods

    • Returns Observable<ToolTypes>

    • Returns Observable<
          {
              annot: Annotation;
              annotationIndex: number;
              pageIndex: number;
              viewPoint: { x: number; y: number };
          },
      >

    • Returns Observable<
          {
              name: ContextMenu;
              operations: number;
              position: { x: number; y: number };
          },
      >

    • Parameters

      Returns void

    • Returns Observable<ESignDocument>

    • Export the document as a plain download — never a save. The file leaves through onExportFile / the browser, and the document keeps its path, its source and its undo history: a download changes nothing about the open document.

      Pass commitChanges: true for user-triggered exports only — it commits the in-progress edit/selection before exporting. Programmatic exports (external autosave) must omit it so the user is never kicked out of an active edit.

      Parameters

      • Optionaloptions: IExportFileModelOptions

      Returns Promise<void>

    • Returns Observable<number>

    • Returns Observable<{ font: IFontAttributes; partialChanges?: IFontAttributes }>

    • Returns ToolTypes

    • Returns IFontAttributes[]

    • Returns string

    • Returns ESignDocument

    • Returns string

    • Returns number

    • Returns IFontAttributes

    • Parameters

      • viewPoint: { x: number; y: number }

      Returns number

    • Parameters

      • pageIndex: number
      • Optionalrect: [number, number, number, number]
      • Optionalzoom: number
      • OptionalpageBox: DrawPageBox

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Returns PdfPageView

    • Returns ITextParagraphAttributes

    • Parameters

      Returns number

    • Returns any

    • Returns string

    • Returns IFontAttributes[]

    • Returns number

    • Returns void

    • Parameters

      • pageIndex: number

      Returns void

    • Returns void

    • Returns Observable<boolean>

    • Returns Observable<boolean>

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      Returns PointModel

    • Parameters

      • pageIndex: number
      • point: { x: number; y: number }

      Returns PointModel

    • Parameters

      Returns QuadModel

    • Parameters

      Returns QuadModel

    • Parameters

      Returns RectModel

    • Parameters

      Returns RectModel

    • Parameters

      Returns SizeModel

    • Parameters

      Returns SizeModel

    • Returns void

    • Returns Observable<CaretRange[]>

    • Returns Observable<void>

    • Returns Observable<number>

    • Returns Observable<PdfPageView>

    • Returns Observable<{ attributes: ITextParagraphAttributes; fromCaret: boolean }>

    • Returns Promise<void>

    • Returns void

    • Returns void

    • Parameters

      • rotate: number

      Returns void

    • Returns Observable<boolean>

    • "Save": write the document back to the source it was opened from. Resolves true once it is saved, false when there is no such source or the target declined/failed — a user cancel of the target's own dialog is a false too, reported as nothing.

      Parameters

      • Optionaloptions: IExportFileModelOptions

      Returns Promise<boolean>

    • "Save as": write the document to target and adopt it as the document's source, so the next saveDocument goes there. Without a target it falls back to the document's own source when that one can take a "Save as", then to the first writable one; with nothing to write to it resolves false and reports the failure.

      Parameters

      • Optionaloptions: IExportFileModelOptions
      • Optionaltarget: ISaveAsTarget

      Returns Promise<boolean>

    • The source this document can be saved back to — the provider plus the item "Save" would overwrite there — or null when it has none (a new document, or a source that is gone or read-only). Decides between "Save" and "Save as".

      Returns { item: IFileItem; provider: IFilesProvider }

    • Returns Observable<{ bar: BLScrollBarType; pos: number }>

    • Parameters

      • text: string
      • flags: PageTextSearchFlags

      Returns Promise<void>

    • Returns Observable<string>

    • Parameters

      Returns Promise<void>

    • Parameters

      Returns void

    • Sets the margins for the document.

      Returns void

    • Parameters

      • doc: ESignDocument
      • Optionalvalidate: { fileType: boolean; maxSize?: number; security: boolean }

      Returns boolean

    • Parameters

      • color: string

      Returns void

    • Parameters

      • font: IFontAttributes
      • Optionalpartial: boolean

      Returns void

    • Parameters

      • enabled: boolean

      Returns void

    • Parameters

      • enable: boolean

      Returns void

    • Parameters

      • marginVertical: number
      • marginHorizontal: number
      • pagesVerticalMargin: number
      • pagesHorizontalMargin: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • attributes: ITextParagraphAttributes

      Returns void

    • Parameters

      • enabled: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      • zoom: number
      • OptionalviewMode: string
      • Optionalpoint: { x: number; y: number }

      Returns void

    • Returns void

    • Returns Observable<number>

    • Returns void

    • Returns void