AG Studio Launch Week 🚀🚀🚀 28 Sep - 2 Oct 2026 🚀🚀🚀 Join now

JavaScript Embedded AnalyticsState Reference

Version 3.0.0

Implements the AgReportState interface. See State for usage details.

AgReportState Copy Link

All pages in the report
selectedPageIdCopy Link
string
The currently selected (displayed) page
panelsCopy Link
Partial<Record<string, AgPanelState>>
Panel state
schemaCopy Link
AgSchemaState
Schema state for the report
versionCopy Link
string
AG Studio version that state was created from. If undefined, will default to latest version

AgPageState Copy Link

string
Unique identifier for the page
widgetsCopy Link
Partial<Record<string, AgValueWidget | AgGridWidget | AgPivotGridWidget | AgColumnChartGrouped | AgColumnChartStacked | AgColumnChartStacked100 | AgBarChartGrouped | AgBarChartStacked | AgBarChartStacked100 | AgLineChart | AgAreaChart | AgAreaChartStacked | AgAreaChartStacked100 | AgScatterChart | AgBubbleChart | AgRadarLineChart | AgRadarAreaChart | AgRadialColumnChart | AgNightingaleChart | AgRadialBarChart | AgPieChart | AgDonutChart | AgFunnelChart | AgConeFunnelChart | AgPyramidChart | AgTreemapChart | AgSunburstChart | AgRadialGauge | AgLinearGauge | AgButtonFilterWidget | AgListFilterWidget | AgDateFilterWidget | AgTextWidget | AgImageWidget | AgComboChartGroupedColumnLine | AgComboChartStackedColumnLine>>
Widget configuration
widgetLayoutCopy Link
Partial<Record<string, AgWidgetLayoutState>>
Widget position and size in the layout
layoutCopy Link
Partial<AgPageLayoutState>
Layout configuration
filterCopy Link
AgFiltersState<TRegistry>
Active page and widget-level filters that show in the filters panel
crossFilterCopy Link
AgCrossFilterState
Active cross-filter selection
selectionCopy Link
AgSelectionState
Active selection (widget or field)