Implementation:Evidentlyai Evidently Dashboard Panels
Appearance
| Knowledge Sources | |
|---|---|
| Domains | ML_Monitoring, Visualization |
| Last Updated | 2026-02-14 12:00 GMT |
Overview
Concrete panel classes for configuring Evidently monitoring dashboard visualizations provided by the Evidently library.
Description
Dashboard panel classes from the legacy UI module:
- DashboardPanelCounter: Displays a single aggregated value (NONE/SUM/LAST)
- DashboardPanelPlot: Displays time-series plots (LINE/BAR/SCATTER)
- DashboardPanelDistribution (alias DashboardPanelHistogram): Distribution histograms
- DashboardPanelTestSuite: Test result aggregation panels
- PanelValue: Helper that references a specific metric field for panel display
Usage
Import panel classes and add them to a Project's dashboard via project.dashboard.add_panel().
Code Reference
Source Location
- Repository: evidently
- File: src/evidently/legacy/ui/dashboards/reports.py (L1-236)
- File: src/evidently/legacy/ui/dashboards/test_suites.py (L91-260)
- File: src/evidently/legacy/ui/dashboards/base.py (PanelValue, ReportFilter)
Signature
class DashboardPanelCounter:
def __init__(self, title: str, filter: ReportFilter, agg: CounterAgg,
value: Optional[PanelValue] = None, text: Optional[str] = None,
size: WidgetSize = WidgetSize.FULL):
class DashboardPanelPlot:
def __init__(self, title: str, filter: ReportFilter, values: List[PanelValue],
plot_type: PlotType, size: WidgetSize = WidgetSize.FULL):
class PanelValue:
def __init__(self, metric_args: Dict[str, Any], field_path: str,
legend: str):
Import
from evidently.legacy.ui.dashboards import (
DashboardPanelCounter,
DashboardPanelPlot,
DashboardPanelDistribution, # alias: DashboardPanelHistogram
DashboardPanelTestSuite,
PanelValue,
ReportFilter,
CounterAgg,
PlotType,
)
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| title | str | Yes | Panel display title |
| filter | ReportFilter | Yes | Filter for which snapshots to include |
| values (Plot) | List[PanelValue] | Yes | Metric values to display |
| plot_type (Plot) | PlotType | Yes | LINE, BAR, or SCATTER |
| agg (Counter) | CounterAgg | Yes | NONE, SUM, or LAST |
| size | WidgetSize | No | FULL or HALF (default: FULL) |
Outputs
| Name | Type | Description |
|---|---|---|
| Panel object | DashboardPanel | Panel added to project dashboard |
Usage Examples
from evidently.legacy.ui.dashboards import (
DashboardPanelPlot, PanelValue, ReportFilter, PlotType,
DashboardPanelCounter, CounterAgg,
)
from evidently.metrics import ValueDrift
# Add a line plot for drift score over time
project.dashboard.add_panel(
DashboardPanelPlot(
title="Age Drift Score",
filter=ReportFilter(metadata_values={}, tag_values=[]),
values=[
PanelValue(
metric_args={"metric.metric_id": ValueDrift(column="age").metric_id},
field_path="value",
legend="Drift Score",
),
],
plot_type=PlotType.LINE,
)
)
project.save()
Related Pages
Implements Principle
Requires Environment
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment