Filter classes

Pages

class form_analyzer.filters.Pages(pages: List[int])

Restricts the fields to the given pages.

Note that page numbers start with 0, so 0 represents the first page, 1 the second page etc.

Parameters: pages – List of pages to take into account (starts with 0)

Page

class form_analyzer.filters.Page(page: int)

Restricts the fields to a single page.

Note that page numbers start with 0, so 0 represents the first page, 1 the second page etc.

Parameters: page – Page to take into account

Location

class form_analyzer.filters.Location(horizontal: Optional[Tuple[float, float]] = None, vertical: Optional[Tuple[float, float]] = None)

Restricts the fields to a given location on a page.

Restrictions are indicated as ratios in the range [0.0, 1.0], so the tuple (.0, 1.0) would indicate the full range and (.5, 1.0) the right/bottom half and (.0, 0.5) the left/upper half.

If a dimension is None, it is not checked (and equal to the full range (.0, 1.0)).

Parameters

horizontal – Horizontal range to take into account (left, right), default None
vertical – Vertical range to take into account (top, bottom), default None

Selected

class form_analyzer.filters.Selected: Restricts the fields to those that are selected (i.e. have a checked checkbox).