Skip to content

Commit 611c201

Browse files
authored
Update README.md
1 parent feefe20 commit 611c201

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ In the following table the list of parameters that can be provided to the `pdf_v
4343
| annotations | A list of annotations to be overlaid on the PDF. Format is described here. |
4444
| pages_vertical_spacing | The vertical space (in pixels) between each page of the PDF. Defaults to 2 pixels. |
4545
| annotation_outline_size | Size of the outline around each annotation in pixels. Defaults to 1 pixel. |
46-
| rendering | Type of rendering: `unwrap` (default), `legacy_iframe`, or `legacy_embed`. The default value, `unwrap` shows the PDF document using pdf.js, and supports the visualisation of annotations. Other values are `legacy_iframe` and `legacy_embed` which use the legacy approach of injecting the document into an `<embed>` or `<iframe>`. These methods enable the default pdf viewer of Firefox/Chrome/Edge that contains additional features we are still working to implement in this component. **NOTE**: Annotations are ignored for both 'legacy_iframe' and 'legacy_embed'. |
47-
| pages_to_render | Filter the rendering to a specific set of pages. By default all pages are rendered. |
46+
| rendering | Type of rendering: `unwrap` (default), `legacy_iframe`, or `legacy_embed`. The default value, `unwrap` shows the PDF document using pdf.js, and supports the visualisation of annotations. Other values are `legacy_iframe` and `legacy_embed` which use the legacy approach of injecting the document into an `<embed>` or `<iframe>`. They allow viewing the PDF using the viewer of the browser that contains additional features we are still working to implement in this component. **IMPORTANT**: :warning: The "legacy" methods **work only with Firefox**, and **do not support annotations**. :warning:|
47+
| pages_to_render | Filter the rendering to a specific set of pages. By default, all pages are rendered. |
48+
4849

4950
### Annotation format
5051
The annotations format has been derived from the [Grobid's coordinate formats](https://grobid.readthedocs.io/en/latest/Coordinates-in-PDF/), which are described as a list of "bounding boxes".

0 commit comments

Comments
 (0)