saberbud/pdfplumber
1
0
Fork 0
mirror of https://github.com/jsvine/pdfplumber.git synced 2026-08-29 08:34:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add .filter description to README

Browse Source
This commit is contained in:
Jeremy Singer-Vine
2016-03-09 07:53:16 -05:00
parent bce81163ef
commit 1c09330d65
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -79,6 +79,8 @@ The `pdfplumber.Page` class is at the core of `pdfplumber`. Most things you'll d
- By default, the cropped page retains objects that fall at least partly within the bounding box. If an object falls only partly within the box, its dimensions are sliced to fit the bounding box.
- Calling `.crop` with `strict=True`, however, retains only objects that fall *entirely* within the bounding box.
- `.filter(test_function)`: Returns a version of the page with only the `.objects` for which `test_function(obj)` returns `True`.
- `.extract_text(x_tolerance=0, y_tolerance=0)`: Collates all of the page's character objects into a single string. Adds spaces where the difference between the `x1` of one character and the `x0` of the next is greater than `x_tolerance`. Adds newline characters where the difference between the `doctop` of one character and the `doctop` of the next is greater than `y_tolerance`.
- `.extract_words(x_tolerance=0, y_tolerance=0)`: Returns a list of all word-looking things and their bounding boxes. Words are considered to be sequences of characters where the difference between the `x1` of one character and the `x0` of the next is less than or equal to `x_tolerance` *and* where the `doctop` of one character and the `doctop` of the next is less than or equal to `y_tolerance`.