Document API

const document = webViewer.document;

open(config: { url: string; filename?: string }): Promise<undefined>;

webViewer.document.open({url:"my-file.pdf", filename:"My File"});
// remote URL
webViewer.document.open({url:"https://example.com/my-file.pdf", filename:"My File"});

download(config?: { fileName?: string; includeAnnotations?: boolean }): Promise<undefined>;

webViewer.document.download({fileName:"my-file.pdf", includeAnnotations:false});

getPages(config?: { pageRange?: string }): Promise<{ pages: PageInfo[] }>;

webViewer.document.getPages({pageRange:"0-3"});

// returns e.g.

{
  pages: [
    {
      pageIndex: 0,
      read: true,
      isVisible: true,
      bbox: {
        width: 595,
        height: 842,
        x: 0,
        y: 0
      }
    }
  ]
}

getPageCount(): Promise<{ pageCount: number }>;

webViewer.document.getPageCount();

// returns e.g

{ pageCount: number }

close(): Promise<undefined>;

webViewer.document.close();

print(config?: { pageRange: string }): Promise<PrintResult>;

webViewer.document.print({pageRange:"0-3"});

// returns e.g.

{ status: 'PRINTED' }

rotatePage(config: { pageRange: string; degree: 0 | 90 | 180 | 270 | 360 }): Promise<undefined>;

webViewer.document.rotatePage({pageRange:"0", degree:webViewer.refs.degree.DEG_90});

getText(config?: { pageRange?: string }): Promise<{ pageIndex: number; text: string }[]>;

async function getText() {
    return webViewer.document.getText({pageRange:"0"});
}

function successCallbackGetText(data) {
    console.log(`Text Data is: ${data[0].text}`);
}

function failureCallbackGetText(error) {
    console.error(`Error getting text: ${error}`);
}

getText().then(successCallbackGetText, failureCallbackGetText);

export(config?: { includeAnnotations?: boolean }): Promise<Uint8Array>;

async function exportDoc() {
    webViewer.toast.show({ type: 'notification', content: 'Exporting ... please wait' });
    webViewer.document.export({includeAnnotations:true}).then(exportSuccess, exportFailure)
};

async function exportSuccess(data) {
    webViewer.toast.show({ type: 'success', content: 'Exporting complete' });
    // do what you need with the `data`
}

async function exportFailure(error) {
    webViewer.toast.show({ type: 'fail', content: 'Export error' });
    console.error(`error: ${error}`);
}

exportDoc()

export interface PageInfo {
  pageIndex: number;
  read: boolean;
  isVisible: boolean;
  bbox: BBox;
}

export interface BBox {
  width: number;
  height: number;
  x: number;
  y: number;
}

export type PrintResult = {
  status: 'PRINTED' | 'CANCELLED';
}