Members
pageNumber :number
Page number of the page. First page is 1.
Type:
- number
- Source:
ref :Object
The reference that points to this page. It has `num` and `gen` properties.
Type:
- Object
- Source:
rotate :number
The number of degrees the page is rotated clockwise.
Type:
- number
- Source:
stats :Object
Returns page stats, if enabled; returns `null` otherwise.
Type:
- Object
- Source:
userUnit :number
The default size of units in 1/72nds of an inch.
Type:
- number
- Source:
view :Array
An array of the visible portion of the PDF page in user space units [x1, y1, x2, y2].
Type:
- Array
- Source:
Methods
cleanup(resetStatsopt) → {boolean}
Cleans up resources allocated by the page.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
resetStats |
boolean |
<optional> |
false | Reset page stats, if enabled. The default value is `false`. |
- Source:
Returns:
Indicating if clean-up was successfully run.
- Type
- boolean
getAnnotations(params) → {Promise}
Parameters:
| Name | Type | Description |
|---|---|---|
params |
GetAnnotationsParameters | Annotation parameters. |
- Source:
Returns:
A promise that is resolved with an {Array} of the
annotation objects.
- Type
- Promise
getOperatorList() → {Promise}
- Source:
Returns:
A promise resolved with an PDFOperatorList
object that represents page's operator list.
- Type
- Promise
getTextContent(params) → {Promise}
Parameters:
| Name | Type | Description |
|---|---|---|
params |
getTextContentParameters | getTextContent parameters. |
- Source:
Returns:
That is resolved a TextContent
object that represent the page text content.
- Type
- Promise
getViewport(params) → {PageViewport}
Parameters:
| Name | Type | Description |
|---|---|---|
params |
GetViewportParameters | Viewport parameters. |
- Source:
Returns:
Contains 'width' and 'height' properties
along with transforms required for rendering.
- Type
- PageViewport
render(params) → {RenderTask}
Begins the process of rendering a page to the desired context.
Parameters:
| Name | Type | Description |
|---|---|---|
params |
RenderParameters | Page render parameters. |
- Source:
Returns:
An object that contains the promise, which
is resolved when the page finishes rendering.
- Type
- RenderTask
streamTextContent(params) → {ReadableStream}
Parameters:
| Name | Type | Description |
|---|---|---|
params |
getTextContentParameters | getTextContent parameters. |
- Source:
Returns:
ReadableStream to read textContent chunks.
- Type
- ReadableStream