# omeka-s-modules/datavis architecture

> Architecture diagram of the GitHub repository omeka-s-modules/datavis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/omeka-s-modules/datavis
- Repository: https://github.com/omeka-s-modules/datavis

## Overview

Data Visualization is an Omeka S module for administrators to configure site-scoped datasets and diagrams, then display them in site pages. The graph follows configuration through the admin form and API-backed visualization record to dataset generation, public dataset/diagram delivery, and browser rendering. README-described dataset and diagram variants are retained even where their individual implementations were not sampled; those branches are not linked by inferred calls. The sampled excerpts show configuration and core APIs, but not every runtime route or renderer integration.

Main entry points: [`src/DatasetType/Manager.php`](https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/Manager.php) (Dataset type manager), [`src/Controller/SiteAdmin/IndexController.php`](https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/SiteAdmin/IndexController.php) (Admin controller), [`src/Form/DatavisForm.php`](https://github.com/omeka-s-modules/datavis/blob/main/src/Form/DatavisForm.php) (Visualization form), [`src/Job/GenerateDataset.php`](https://github.com/omeka-s-modules/datavis/blob/main/src/Job/GenerateDataset.php) (Dataset generation job)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_admin["Admin configuration"]
  node_admin_controller["Admin controller"]
  node_admin_form["Visualization form<br/>[DatavisForm.php]"]
  node_dataset_form["Dataset type form"]
  node_form_controls["Form controls"]
end

subgraph group_data["Dataset generation"]
  node_dataset_manager["Dataset type manager<br/>[Manager.php]"]
  node_dataset_base["Dataset base"]
  node_item_counts["Item count datasets"]
  node_property_counts["Property datasets"]
  node_relationships["Item relationships"]
  node_generate_job["Dataset generation job"]
end

subgraph group_render["Site rendering"]
  node_diagram_manager["Diagram type manager<br/>[Manager.php]"]
  node_chart_types["Chart diagrams<br/>[ColumnChart.php]"]
  node_network_diagrams["Network diagrams<br/>[NetworkGraph.php]"]
  node_site_controller["Site controller"]
  node_site_block["Page visualization block<br/>[Datavis.php]"]
  node_dataset_endpoint["Dataset endpoint"]
  node_render_markup["Diagram markup"]
  node_render_dispatch["Browser renderer<br/>[diagram-render.js]"]
  node_render_variants["Diagram renderers"]
end

subgraph group_record["Visualization records"]
  node_vis_record[("Visualization entity<br/>[DatavisVis.php]")]
  node_vis_adapter["Visualization API"]
  node_vis_representation["Visualization representation"]
end

node_admin_user(("Site administrator"))
node_api_search["Omeka item API"]
node_site_visitor(("Site visitor"))

node_admin_user -->|"configures"| node_admin_controller
node_admin_controller -->|"builds"| node_admin_form
node_admin_form -->|"selects dataset"| node_dataset_manager
node_admin_form -->|"selects diagram"| node_diagram_manager
node_admin_form -.->|"uses controls"| node_form_controls
node_admin_controller -->|"creates record"| node_vis_adapter
node_admin_controller -->|"dispatches job"| node_generate_job
node_dataset_manager -->|"provides type"| node_item_counts
node_dataset_manager -->|"provides type"| node_property_counts
node_dataset_manager -->|"provides type"| node_relationships
node_item_counts -->|"extends"| node_dataset_base
node_property_counts -->|"extends"| node_dataset_base
node_relationships -->|"extends"| node_dataset_base
node_dataset_base -->|"searches items"| node_api_search
node_generate_job -->|"reads record"| node_vis_record
node_generate_job -.->|"selects type"| node_dataset_manager
node_generate_job -.->|"stores dataset"| node_vis_record
node_diagram_manager -->|"provides type"| node_chart_types
node_diagram_manager -->|"provides type"| node_network_diagrams
node_vis_adapter -->|"hydrates entity"| node_vis_record
node_vis_adapter -->|"represents entity"| node_vis_representation
node_site_visitor -.->|"requests diagram"| node_site_controller
node_site_block -.->|"renders visualization"| node_vis_representation
node_site_controller -.->|"serves dataset"| node_dataset_endpoint
node_vis_representation -->|"produces markup"| node_render_markup
node_render_markup -->|"loads script"| node_render_dispatch
node_render_dispatch -.->|"dispatches renderer"| node_render_variants
node_chart_types -.->|"renders charts"| node_render_variants
node_network_diagrams -.->|"renders graphs"| node_render_variants

click node_admin_controller "https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/SiteAdmin/IndexController.php"
click node_admin_form "https://github.com/omeka-s-modules/datavis/blob/main/src/Form/DatavisForm.php"
click node_dataset_form "https://github.com/omeka-s-modules/datavis/blob/main/src/Form/DatasetTypeForm.php"
click node_form_controls "https://github.com/omeka-s-modules/datavis/tree/main/src/Form/Element"
click node_dataset_manager "https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/Manager.php"
click node_dataset_base "https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/AbstractDatasetType.php"
click node_item_counts "https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/CountItemsClasses.php"
click node_property_counts "https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/CountPropertyValues.php"
click node_relationships "https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/ItemRelationships.php"
click node_generate_job "https://github.com/omeka-s-modules/datavis/blob/main/src/Job/GenerateDataset.php"
click node_diagram_manager "https://github.com/omeka-s-modules/datavis/blob/main/src/DiagramType/Manager.php"
click node_chart_types "https://github.com/omeka-s-modules/datavis/blob/main/src/DiagramType/ColumnChart.php"
click node_network_diagrams "https://github.com/omeka-s-modules/datavis/blob/main/src/DiagramType/NetworkGraph.php"
click node_vis_record "https://github.com/omeka-s-modules/datavis/blob/main/src/Entity/DatavisVis.php"
click node_vis_adapter "https://github.com/omeka-s-modules/datavis/blob/main/src/Api/Adapter/DatavisVisAdapter.php"
click node_vis_representation "https://github.com/omeka-s-modules/datavis/blob/main/src/Api/Representation/DatavisVisRepresentation.php"
click node_site_controller "https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/Site/IndexController.php"
click node_site_block "https://github.com/omeka-s-modules/datavis/blob/main/src/Site/BlockLayout/Datavis.php"
click node_dataset_endpoint "https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/Site/IndexController.php"
click node_render_markup "https://github.com/omeka-s-modules/datavis/blob/main/src/Api/Representation/DatavisVisRepresentation.php"
click node_render_dispatch "https://github.com/omeka-s-modules/datavis/blob/main/asset/js/diagram-render.js"
click node_render_variants "https://github.com/omeka-s-modules/datavis/tree/main/asset/js/diagram-render"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_admin_controller,node_admin_form,node_dataset_form,node_form_controls toneBlue
class node_dataset_manager,node_dataset_base,node_item_counts,node_property_counts,node_relationships,node_generate_job toneAmber
class node_diagram_manager,node_chart_types,node_network_diagrams,node_site_controller,node_site_block,node_dataset_endpoint,node_render_markup,node_render_dispatch,node_render_variants,node_api_search toneMint
class node_vis_record,node_vis_adapter,node_vis_representation toneRose
class node_admin_user,node_site_visitor toneIndigo
```

## Components

### Admin configuration

- [Admin controller](https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/SiteAdmin/IndexController.php): `src/Controller/SiteAdmin/IndexController.php`
- [Visualization form](https://github.com/omeka-s-modules/datavis/blob/main/src/Form/DatavisForm.php): `src/Form/DatavisForm.php`
- [Dataset type form](https://github.com/omeka-s-modules/datavis/blob/main/src/Form/DatasetTypeForm.php): `src/Form/DatasetTypeForm.php`
- [Form controls](https://github.com/omeka-s-modules/datavis/tree/main/src/Form/Element): `src/Form/Element`

### Dataset generation

- [Dataset type manager](https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/Manager.php): `src/DatasetType/Manager.php`
- [Dataset base](https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/AbstractDatasetType.php): `src/DatasetType/AbstractDatasetType.php`
- [Item count datasets](https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/CountItemsClasses.php): `src/DatasetType/CountItemsClasses.php`
- [Property datasets](https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/CountPropertyValues.php): `src/DatasetType/CountPropertyValues.php`
- [Item relationships](https://github.com/omeka-s-modules/datavis/blob/main/src/DatasetType/ItemRelationships.php): `src/DatasetType/ItemRelationships.php`
- [Dataset generation job](https://github.com/omeka-s-modules/datavis/blob/main/src/Job/GenerateDataset.php): `src/Job/GenerateDataset.php`

### Site rendering

- [Diagram type manager](https://github.com/omeka-s-modules/datavis/blob/main/src/DiagramType/Manager.php): `src/DiagramType/Manager.php`
- [Chart diagrams](https://github.com/omeka-s-modules/datavis/blob/main/src/DiagramType/ColumnChart.php): `src/DiagramType/ColumnChart.php`
- [Network diagrams](https://github.com/omeka-s-modules/datavis/blob/main/src/DiagramType/NetworkGraph.php): `src/DiagramType/NetworkGraph.php`
- [Site controller](https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/Site/IndexController.php): `src/Controller/Site/IndexController.php`
- [Page visualization block](https://github.com/omeka-s-modules/datavis/blob/main/src/Site/BlockLayout/Datavis.php): `src/Site/BlockLayout/Datavis.php`
- [Dataset endpoint](https://github.com/omeka-s-modules/datavis/blob/main/src/Controller/Site/IndexController.php): `src/Controller/Site/IndexController.php`
- [Diagram markup](https://github.com/omeka-s-modules/datavis/blob/main/src/Api/Representation/DatavisVisRepresentation.php): `src/Api/Representation/DatavisVisRepresentation.php`
- [Browser renderer](https://github.com/omeka-s-modules/datavis/blob/main/asset/js/diagram-render.js): `asset/js/diagram-render.js`
- [Diagram renderers](https://github.com/omeka-s-modules/datavis/tree/main/asset/js/diagram-render): `asset/js/diagram-render`

### Visualization records

- [Visualization entity](https://github.com/omeka-s-modules/datavis/blob/main/src/Entity/DatavisVis.php): `src/Entity/DatavisVis.php`
- [Visualization API](https://github.com/omeka-s-modules/datavis/blob/main/src/Api/Adapter/DatavisVisAdapter.php): `src/Api/Adapter/DatavisVisAdapter.php`
- [Visualization representation](https://github.com/omeka-s-modules/datavis/blob/main/src/Api/Representation/DatavisVisRepresentation.php): `src/Api/Representation/DatavisVisRepresentation.php`

### Other components

- **Site administrator**
- **Omeka item API**
- **Site visitor**

## Connections

- Site administrator → Admin controller: configures
- Admin controller → Visualization form: builds (evidence: `src/Controller/SiteAdmin/IndexController.php`)
- Visualization form → Dataset type manager: selects dataset (evidence: `src/Form/DatavisForm.php`)
- Visualization form → Diagram type manager: selects diagram (evidence: `src/Form/DatavisForm.php`)
- Visualization form → Form controls: uses controls (evidence: `src/Form/DatavisForm.php`)
- Admin controller → Visualization API: creates record (evidence: `src/Controller/SiteAdmin/IndexController.php`)
- Admin controller → Dataset generation job: dispatches job (evidence: `src/Controller/SiteAdmin/IndexController.php`)
- Dataset type manager → Item count datasets: provides type
- Dataset type manager → Property datasets: provides type
- Dataset type manager → Item relationships: provides type
- Item count datasets → Dataset base: extends (evidence: `src/DatasetType/CountItemsClasses.php`)
- Property datasets → Dataset base: extends (evidence: `src/DatasetType/CountPropertyValues.php`)
- Item relationships → Dataset base: extends (evidence: `src/DatasetType/ItemRelationships.php`)
- Dataset base → Omeka item API: searches items (evidence: `src/DatasetType/AbstractDatasetType.php`)
- Dataset generation job → Visualization entity: reads record (evidence: `src/Job/GenerateDataset.php`)
- Dataset generation job → Dataset type manager: selects type
- Dataset generation job → Visualization entity: stores dataset (evidence: `src/Job/GenerateDataset.php`)
- Diagram type manager → Chart diagrams: provides type
- Diagram type manager → Network diagrams: provides type
- Visualization API → Visualization entity: hydrates entity (evidence: `src/Api/Adapter/DatavisVisAdapter.php`)
- Visualization API → Visualization representation: represents entity (evidence: `src/Api/Adapter/DatavisVisAdapter.php`)
- Site visitor → Site controller: requests diagram
- Page visualization block → Visualization representation: renders visualization
- Site controller → Dataset endpoint: serves dataset (evidence: `src/Controller/Site/IndexController.php`)
- Visualization representation → Diagram markup: produces markup (evidence: `src/Api/Representation/DatavisVisRepresentation.php`)
- Diagram markup → Browser renderer: loads script (evidence: `src/Api/Representation/DatavisVisRepresentation.php`)
- Browser renderer → Diagram renderers: dispatches renderer
- Chart diagrams → Diagram renderers: renders charts
- Network diagrams → Diagram renderers: renders graphs
