Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Layout Provider

Embedded Object Grooper.Extract

Defines the base class for all array layout providers in Grooper, enabling detection and extraction of arrays based on document structure.

Remarks

The Layout Provider class serves as the foundation for all array layout detection strategies in Grooper.

Layout providers are responsible for determining how arrays of values are identified within a document, based on their spatial arrangement, text flow, or other structural cues.

Derived classes implement specific layout detection logic, such as horizontal rows, vertical columns, or text flow-based arrays.

How It Works

  • A Layout Provider analyzes the positions and relationships of candidate elements in a document to determine which ones should be grouped as an array.
  • Each derived provider (such as Horizontal, Vertical, or Flow) uses its own rules for alignment, distance, and separator detection.
  • Layout providers are configured as part of a data type or extraction node, allowing users to tailor array detection to the structure of their documents.

Configuration Guidance

  • Choose the appropriate layout provider for your data: use Horizontal for rows, Vertical for columns, and Flow for sequential text.
  • Configure provider-specific properties (such as alignment, distance, or separator expression) to match the expected document structure.
  • Test extraction results and adjust settings as needed to ensure accurate grouping of array elements.

Properties

NameTypeDescription

Derived Types

There are 3 implementations of Layout Provider.

Flow Detects cases where array elements occur one after another in the text flow of a document.
Horizontal Detects cases where array elements are arranged in a horizontal row within the document layout.
Vertical Detects cases where array elements are arranged in a vertical column within the document layout.
Notification