Data Inspector

Provides an interactive user interface for inspecting and navigating Data Instance hierarchies within a batch document.

Remarks

The Data Inspector is a specialized UI component for exploring, analyzing, and validating the structure and content of extracted data in Grooper. It visualizes the Data Instance hierarchy as a tree, allowing users to drill down into fields, sections, tables, and other data elements produced by the extraction process, and to see how these elements relate to the original document content.

Purpose and Functionality

• Hierarchical Data Exploration:
  Presents the full hierarchy of Data Instances for a document or set of documents in a collapsible tree view.
• Selection and Highlighting:
  Selecting a node in the tree displays its value, properties, and relationships, and highlights the corresponding region in the integrated {DocumentViewer}.
• Annotation and Visualization:
  Supports visual annotations and decorations for each data element, making it easy to see how extraction results map to the underlying document content.
• Multi-Root Support:
  Can be initialized with a single Data Instance or multiple root instances, supporting both single-document and multi-document inspection scenarios.
• Session Continuity:
  Automatically saves its session state, preserving navigation and selection across user interactions.

UI Components

• Data Tree:
  • Displays the hierarchy of Data Instances in a tree structure, with expandable/collapsible nodes for fields, sections, tables, and collections.
  • Selecting a node updates the rest of the UI to show details and highlights.
• Document Viewer:
  • Shows the current document and highlights the selected data instance or region.
  • Supports zooming, panning, and page navigation.
• Annotations:
  • Visual overlays and highlights on the document image or text, indicating the location and extent of selected data elements.
• Properties Panel (if present):
  • Displays detailed properties and metadata for the selected data instance.

Example

The following diagram illustrates the layout of the Data Inspector:

┌──────────────────────────────────────────────────────────────────────────────┐
│ Data Inspector                                                               │
├──────────────────────────────────────────────────────────────────────────────┤
│ ┌────────────── Data Tree ──────────────┐ ┌───── Document Viewer ──────────┐ │
│ │                                       │ │                                │ │
│ │                                       │ │                                │ │
│ └───────────────────────────────────────┘ └────────────────────────────────┘ │
└──────────────────────────────────────────────────────────────────────────────┘

• Data Tree: Hierarchical tree of Data Instances.
• Document Viewer: Preview of the document with highlighted regions for the selected data element.

Usage Tips

• Use the Data Tree to navigate through fields, sections, tables, and other data elements.
• Selecting a node in the tree highlights the corresponding region in the document viewer.
• Use the integrated annotations to understand how extraction results map to the source document.
• The Data Inspector is ideal for troubleshooting, solution development, and training, providing a clear visualization of Grooper's data model in action.
• For advanced review, use the GetAnnotations method to retrieve and analyze visual overlays for any data instance and page.

The Data Inspector streamlines the process of reviewing, validating, and understanding extracted data, making it an essential tool for solution designers, reviewers, and anyone working with Grooper's data extraction and modeling features.

Child Controls

┌────────────── Data Tree ──────────────┐
│ • Invoice Document                    │
│   ├─ Invoice Number: 12345            │
│   ├─ Vendor                           │
│   │   └─ Name: Acme Corp              │
│   └─ Line Items                       │
│       ├─ Row 1                        │
│       └─ Row 2                        │
└───────────────────────────────────────┘