PDFPageProxy
Unofficial
Proxy for a single PDF page.
Import:
import type { PDFPageProxy } from '@obsidian-typings/obsidian-catalyst-latest';Signature:
export interface PDFPageProxyProperties
| Property | Type | Description | |
|---|---|---|---|
| pageNumber | number | Page number (1-based). | |
| ref | null | object | Reference object for the page, if available. | |
| rotate | number | Page rotation angle in degrees. | |
| userUnit | number | User unit size. | |
| view | number[] | The page view box coordinates. |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| cleanup(resetStats?) | boolean | Cleans up resources held by the page. | |
| getAnnotations(params?) | Promise<unknown[]> | Gets the annotations for the page. | |
| getOperatorList() | Promise<unknown> | Gets the operator list for the page. | |
| getTextContent(params?) | Promise<TextContent> | Gets the text content of the page. | |
| getViewport(params) | PageViewport | Gets the viewport for the page. | |
| render(params) | RenderTask | Renders the page to a canvas context. | |
| streamTextContent(params?) | ReadableStream | Streams the text content of the page. |
Links to this page: