Skip to main content
A simple grid card that displays data objects for a specific group taxon in a tabular format. This component provides basic grid functionality with automatic column configuration based on the taxon structure.

​
Type

type: "grid"
This component doesn’t have a registered metadata file - it’s used internally by other components.

​
Properties

PropertyTypeDescription
groupTaxonstringThe taxon path identifying which data element group to display

​
Layout

This component is typically embedded within other card layouts and adapts to its container size.

​
Configuration Example

- type: grid
  id: customerGrid
  properties:
    groupTaxon: "customer"
  layout:
    x: 0
    y: 0
    w: 12
    h: 8

​
Features

​
Automatic Data Scoping

The grid automatically scopes data objects based on:
  1. Group taxon match: Filters objects matching the configured group taxon path
  2. Parent data object: If provided, shows only child objects of the parent
  3. Empty object filtering: Automatically excludes empty data objects (handled at store level)

​
Grid Configuration

  • Non-groupable: The grid doesn’t support grouping features
  • No column menu: Column configuration menu is hidden for simplicity
  • Automatic columns: Columns are auto-generated based on taxon structure

​
Advanced Usage

​
Data Object Filtering

The component uses computed properties to efficiently filter data objects:
  • Filters by exact path match to the group taxon
  • Optionally filters by parent data object ID if parent is provided
  • Reactive updates when data objects change in the store

​
Integration with Data Form Viewer

The grid integrates with the data form viewer store to:
  • Access the current set of data objects
  • Reactively update when data changes
  • Share state across multiple card components

​
Notes

  • This is a simplified grid component without advanced features like editing, sorting, or filtering
  • The component requires a valid group taxon metadata to function
  • If no group taxon metadata is found, the grid displays nothing
  • Empty objects are filtered at the store level, so the grid only receives valid objects
  • The component uses the KodexaDataObjectGrid component for rendering
  • No header is displayed in the grid (showHeader is not configurable)
  • The grid is non-editable and read-only