AG Studio: Build dashboards using native components in web apps. Join us for a webinar on 28th July at 2pm UTC+1 Register
AG Grid
Best JavaScript Grid in the World
AG Charts
Best JavaScript Charts in the World
AG Studio
Best JavaScript Dashboard in the World
Bryntum Gantt
Speed-tuned Gantt chart for project planning
Bryntum Scheduler
Resource scheduling timeline component
PROPRO
Bryntum Scheduler Pro
Scheduler with auto-scheduling and constraints
Bryntum Calendar
Flexible JavaScript event calendar
Bryntum Task Board
Kanban-style task board component
Search
What's New
AG Studio: Reference
Studio
OverviewProperties ReferenceEvents ReferenceAPI ReferenceTheme ReferenceState ReferenceStudio LifecycleRegistry Type

React Embedded AnalyticsState Reference

Version 2.1.2

Implements the AgReportState interface. See State for usage details.

AgReportState Copy Link

pagesCopy Link
AgPageState<TRegistry>[]
All pages in the report
selectedPageIdCopy Link
string
The currently selected (displayed) page
panelsCopy Link
Partial<Record<string, AgPanelState>>
Panel state
aiCopy Link
AgAiAssistantState
AI Assistant state
versionCopy Link
string
AG Studio version that state was created from. If undefined, will default to latest version

AgPageState Copy Link

idCopy 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)
schemaCopy Link
AgSchemaState
Schema state for the page

AgAiAssistantState Copy Link

activeThreadIdCopy Link
string
ID of the currently active thread
threadsCopy Link
AgAiThreadState[]
All threads associated with the AI assistant