New to Telerik UI for Blazor? Start a free 30-day trial

Grid-specific visualization configuration.

Canonical JSON Schema: src/common/models/grid.schema.json. When adding a new property, update the schema file first, then add the matching C# property here.

Definition

Namespace:Telerik.Blazor.Components.DatAInsightsComposer

Assembly:Telerik.Blazor.DatAInsightsComposer.dll

Syntax:

C#
public class GridConfig

Inheritance: objectGridConfig

Constructors

C#
public GridConfig()

Properties

Columns to display in the grid.

C#
public List<GridColumnConfig> Columns { get; set; }

Shared dataset filter/sort/group/take, applied before rendering.

C#
public DataSourceConfig? DataSource { get; set; }

Filter mode for the grid. null means the model did not request filtering.

C#
public GridFilterMode? FilterMode { get; set; }

Whether grouping is enabled. null means the model did not request this feature.

C#
public bool? Groupable { get; set; }

Component height as a CSS size (e.g. "400px", "50%"). Set only if the user explicitly asks for a height; otherwise leave null.

C#
public string? Height { get; set; }

Number of rows per page. null means the model did not request paging (renderer defaults to 20).

C#
public int? PageSize { get; set; }

Whether column reordering via drag-and-drop is enabled. null means not requested.

C#
public bool? Reorderable { get; set; }

Whether column resizing via drag handles is enabled. null means not requested.

C#
public bool? Resizable { get; set; }

Scroll mode for the grid. When set to Virtual, the grid uses virtual scrolling. null means the model did not request virtualization (renderer defaults to Scrollable).

C#
public GridScrollMode? ScrollMode { get; set; }

Row selection mode. null means the model did not request selection (renderer defaults to None).

C#
public GridSelectionMode? SelectionMode { get; set; }

Whether to show a search box in the toolbar. null means not requested.

C#
public bool? ShowSearchBox { get; set; }

Whether to show a toolbar with export buttons. null means not requested.

C#
public bool? ShowToolBar { get; set; }

Whether sorting is enabled. null means the model did not request this feature.

C#
public bool? Sortable { get; set; }

Component width as a CSS size (e.g. "600px", "50%"). Set only if the user explicitly asks for a width; otherwise leave null (the grid fills its container and scrolls horizontally when columns overflow).

C#
public string? Width { get; set; }