Data View Block
Embed an interactive data view showing model entities with clickable entity overlays. Readers can explore entity properties, types, and relationships in persistence or search mode.
Data view blocks embed interactive entity diagrams directly into your documentation pages. Unlike static ERD images, data views let readers click on individual entities to open an overlay showing properties, types, constraints, and relationships. The data view renders entities from your model with full type information resolved through the active profile.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Data View Path | Yes | Path to the data view definition |
| Title | No | Optional title displayed above the data view |
| View Mode | Yes | Either persistence (database-focused) or search (index-focused) |
View Modes
Entity Overlay
Clicking any entity in the data view opens the entity overlay, a slide-out panel showing the complete property list for that entity.
| Overlay Feature | Description |
|---|---|
| Property List | All properties with resolved names and types from the active profile |
| Relationship Pills | Clickable pills showing foreign key targets, navigating to the related entity |
| Constraints | Required, unique, and other constraints displayed per property |
| Property Drilldown | Expand any property to see its full configuration including governance and derivation |
Data View vs Diagram Block
| Capability | Data View Block | Diagram Block |
|---|---|---|
| Entity Inspection | Full property overlay on click | No property details |
| Profile Resolution | Types resolved through database or search profile | No profile awareness |
| Relationship Navigation | Click-through to related entities | Visual connectors only |
| Best For | Data architecture reference | General architecture diagrams |