AG Studio Launch Week 🚀🚀🚀 28 Sep - 2 Oct 2026 🚀🚀🚀 Join now
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⌘ KCtrl K
What's New
Getting Started
OverviewQuick StartBuilding a DashboardMigrationEnterprise Licence
AI Skills
Connecting Data
Data OverviewData ModellingLoading DataSharing & Caching Data
Agent Framework
Agent Framework OverviewAgent Quick Start
WebMCP
Fields & Formatting
Data TypesFormattingExpressionsCalendarsEditable Fields
Appearance & Behaviour
Modes & LayoutThemingTheme BuilderLocalisationStateUndo & RedoExportingFigma Design System
Widgets
Widgets OverviewConfiguring WidgetsCustom WidgetsForm Configuration
Server-Side Data
Custom EngineImplementing Queries
User Guide
Working with AI

JavaScript Embedded AnalyticsConfiguring Widgets

Version 3.0.0

The set of widgets available to report authors, and the configuration of each individual widget, can both be customised through the widgets property.

Available Widgets Copy Link

The example above changes the list of available widgets to:

  • Add new groups of widgets
  • Show one of the groups collapsed by default
  • Re-use one of the default widget groups
  • Change the default widget type when dragging fields to the Value widget
const studioProperties = {
    widgets: createWidgets({
        menu: [
            // new menu configuration
        ],
        defaultType: 'value',
    }),

    // other studio properties ...
}

See the Widget Configuration API for details on the createWidgets helper function.

Widget Overrides Copy Link

The example above changes the configuration for the Table widget to update the label from 'Table' to 'Grid', and move the widget selection input to the bottom of the setup tab.

const studioProperties = {
    widgets: createWidgets({
        overrides: [
            {
                id: 'grid',
                label: 'Grid',
                // ... other overrides
            }
        ]
    }),

    // other studio properties ...
}

Updating the form property for a widget allows the items in the Edit Panel to be customised, including changing their default values. See Form Configuration for more details.

Pre-Configured Widgets Copy Link

The example above updates the widget configuration to have two pre-configured widgets. These re-use the existing grouped column chart widgets, but set the fields and title, and hide all of the form options except for the widget selection input.

The pre-configured widgets are set up in a similar way to Creating a Custom Widget, but they copy the existing grouped column chart widget definition.

The extends property is set to 'column-chart-grouped' so that all of the default values are set correctly, and the defaultState property is set with the desired data mapping, sort and title details.

Cell Renderers Copy Link

Table and pivot table widgets can render their cells with your own components, using AG Grid cell renderers.

The example above renders a gold circle next to each value in the 'Gold' column of both widgets, a flag next to each country and a weather icon next to each year on the pivot table widget's Row Labels axis.

A field or Format definition can carry a context property holding any data your application needs. The createCellRenderer option on the table and pivot table widgets receives each field and can return a cell renderer, or undefined to keep the default rendering.

On the pivot table widget the option also covers the fields on the Row Labels axis, with two differences worth knowing:

  • A Row Labels renderer is rendered inside the row's group cell, alongside its expand control and indentation, rather than replacing the cell.
  • A Row Labels renderer receives no field information in its cell renderer params, so a renderer that needs to know which field it is rendering should close over the field passed to the callback.
const fields = [
    // ... other fields
    { id: 'gold', context: { cellRenderer: 'gold' } },
    { id: 'country', context: { cellRenderer: 'countryFlag' } },
    { id: 'year', context: { cellRenderer: 'olympicSeason' } },
]
const studioProperties = {
    widgets: createWidgets({
        overrides: [
            {
                id: 'grid',
                options: {
                    createCellRenderer: (field) =>
                        field.context != null && field.context.cellRenderer === 'gold'
                             ? GoldCellRenderer
                             : undefined,
                },
            },
            {
                id: 'pivot-grid',
                options: {
                    createCellRenderer: (field) => {
                        switch (field.context != null ? field.context.cellRenderer : undefined) {
                            case 'countryFlag':
                                return CountryFlagCellRenderer;
                            case 'olympicSeason':
                                return OlympicSeasonCellRenderer;
                            case 'gold':
                                return GoldCellRenderer;
                            default:
                                return undefined;
                        }
                    },
                },
            },
        ],
    }),

    // other studio properties ...
}

Refer to the AG Grid Cell Component Documentation for more details on how to create custom cell renderers.

Toolbar Actions Copy Link

Each widget has a toolbar containing buttons that trigger various actions.

To customise the toolbar, follow the steps for Widget Overrides and set the toolbar property.

The following actions are available by default:

ActionIDWidgets
Duplicate widget'duplicate'All
Delete widget'delete'All
CSV export'export'Grid and chart widgets
Download as image'download'Chart widgets

Actions can also be executed via the API method performWidgetAction.

performWidgetActionCopy Link
Function
Execute an action for a widget. Action can be one of the default actions ('duplicate' or 'delete'), or an action specific to that widget.

The example above demonstrates exporting data for the first widget via the API when the button is clicked.

CSV Export Copy Link

When performing CSV export, values are formatted the same way as in the widget.

By default, exports are limited to 1,000 rows by applying a limit on the related query. Set maxExportRows on dataOptions to change this.

const studioProperties = {
    dataOptions: {
        maxExportRows: 5000,
    },

    // other studio properties ...
}

maxExportRows supports -1 for unlimited exports. Depending on the size of your data, you may get unexpected or undesired results, including but not limited to: memory, bandwidth or resource exhaustion.