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

Data Tree

Control GrooperReview.Pages.Design

Displays a data instance hierarchy in a tree control.

Remarks

The Data Tree control provides an interactive, hierarchical view of data instances within a document or data model. It is designed to help users explore, understand, and navigate the structure and relationships of extracted data, including fields, sections, tables, and their values. The tree visually represents the parent-child relationships and collections that make up the data model, supporting both simple and complex document schemas.

Purpose and Functionality

  • Hierarchical Navigation:
    Presents the full hierarchy of Data Instances in a collapsible tree, including fields, sections, tables, and their children.
  • Expandable Nodes:
    Each node can be expanded or collapsed to show or hide its child data instances and collections.
  • Contextual Display:
    Nodes display the name or type of each data instance, and may include additional context such as collection names (e.g., "Alternates", "Context", "Row Headers").
  • Leaf and Collection Handling:
    Leaf nodes represent data instances with no children or collections. Special handling is provided for tables, alternates, and context collections.
  • Selection and Focus:
    Selecting a node in the tree highlights the corresponding data instance and may trigger updates in related UI components (such as data inspectors or viewers).

UI Components

  • Tree View:
    • The main area displays a hierarchical tree of data instances, with expandable/collapsible nodes.
    • Each node shows the display name or type of the data instance.
    • Collection nodes (such as "Alternates" or "Context") group related data instances under a common label.
  • ARIA and Accessibility:
    • The tree supports keyboard navigation and is accessible via ARIA roles.
  • Integration:
    • The Data Tree is often used within the Data Inspector or data review panels, and may interact with other controls for synchronized selection or highlighting.

Example

The following diagram illustrates the layout of the Data Tree, showing a typical data instance hierarchy:

┌────────────────── Data Tree ─────────────────┐
│ • Invoice Document                           │
│   ├─ Invoice Number: 12345                   │
│   ├─ Invoice Date: 2024-07-01                │
│   ├─ Vendor                                  │
│   │   ├─ Name: Acme Corp                     │
│   │   └─ Address: 123 Main St                │
│   ├─ Line Items                              │
│   │   ├─ Row 1                               │
│   │   │   ├─ Description: Widget             │
│   │   │   ├─ Quantity: 10                    │
│   │   │   └─ Price: 5.00                     │
│   │   └─ Row 2                               │
│   │       ├─ Description: Gadget             │
│   │       ├─ Quantity: 2                     │
│   │       └─ Price: 15.00                    │
│   └─ Total: 80.00                            │
└──────────────────────────────────────────────┘
  • Nodes with children can be expanded or collapsed.
  • Collections such as "Line Items" or "Alternates" are grouped under their respective parent nodes.
  • Leaf nodes display the value of the data instance, if available.

Usage Tips

  • Click or expand nodes to explore the structure of extracted data.
  • Use keyboard navigation to move between nodes and collections.
  • Selecting a node may highlight the corresponding data in other panels, such as viewers or inspectors.
  • Collections (such as alternates or context) help you understand the relationships and options for each data instance.

The Data Tree control makes it easy to visualize, navigate, and understand the structure of extracted data, supporting validation, troubleshooting, and advanced data review workflows.

Used By

Notification