Props
Name | Description | Type | Default |
---|---|---|---|
characterMap | Specify the character map (CMap) to be used for text rendering. | CharacterMap | undefined |
darkMode | To set dark theme for the VPV. This can be used with the @update:dark-mode event. | v-model:boolean | false |
initialRotation | The initial rotation of the PDF document with respect to the VPV viewer. | number | 0 (0, 90, 180, 270) |
initialScale | The initial zoom level of the PDF document with respect to VPV. If unspecified, it is determined by the page dimensions and the width of the container. | number | ZoomLevel.PageFit (Scale ranges from 0 to 1.) |
initialScrollMode | The initial scroll mode of VPV. | ScrollMode | ScrollMode.Vertical |
initialPage | The page number of the PDF document that will be displayed on first load. | number | 1 |
initialViewMode | The initial view mode of VPV. | ViewMode | ViewMode.SinglePage |
initialThumbnails-visible | To display thumbnail on first load | boolean | false |
initialSearch | set initial text to search in PDF | v-model:string | undefined |
src | Source of the PDF document | string, Ref<string> | - |
textLayer | A layer on a PDF to allow users to select text Remark: Search, highlight text, and selection mode features depend on this property. If you disable it, these features won't work. | boolean | true |
toolbarOptions | Determine whether the toolbar is visible in the VPV. Remark: The toolbar consists of top bar and left sidebar. | Partial<ToolbarOptions> | false |
workerUrl | The URL or relative path pointing to the web worker file for handling PDF document which must correspond to the pdfjs-dist version being used. Normally, you will not need to configure the workerURL . To do so, please refer to overriding dependency | string | - |
locale | The locale string key, which must match the key of the localization object; otherwise, it will fall back to en_US | v-model:string | en_US |
localization | The locale object that will be used in the component | Record<string, Localization> | { en_US: ...locale, zh_CN: ...locale, it_IT: ...locale, pt_PT: ...locale, th_TH: ...locale } |
afterCanvasLoaded | callback function to call after canvas layer is rendered of each page | Record<number, CanvasLoadedCallback> | undefined |