diff --git a/docs/data/charts/funnel/funnel.md b/docs/data/charts/funnel/funnel.md index e29d5b52cbe62..7026034695399 100644 --- a/docs/data/charts/funnel/funnel.md +++ b/docs/data/charts/funnel/funnel.md @@ -2,7 +2,7 @@ title: React Funnel chart --- -# Charts - Funnel [](/x/introduction/licensing/#pro-plan 'Pro plan') +# Charts - Funnel [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Funnel charts allow to express quantity evolution along a process, such as audience engagement.

diff --git a/docs/data/charts/gantt/gantt.md b/docs/data/charts/gantt/gantt.md index e3c9df5bc52e9..41985fa001fea 100644 --- a/docs/data/charts/gantt/gantt.md +++ b/docs/data/charts/gantt/gantt.md @@ -2,7 +2,7 @@ title: React Gantt chart --- -# Charts - Gantt [](/x/introduction/licensing/#pro-plan 'Pro plan') +# Charts - Gantt [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Gantt charts can illustrate a schedule and the relationships between its various activities.

diff --git a/docs/data/charts/gauge/gauge.md b/docs/data/charts/gauge/gauge.md index dd9be0429e86f..d025f1f7b3e98 100644 --- a/docs/data/charts/gauge/gauge.md +++ b/docs/data/charts/gauge/gauge.md @@ -2,7 +2,7 @@ title: React Gauge chart --- -# Charts - Gauge +# Charts - Gauge 🚧

Gauge charts let the user evaluate metrics.

diff --git a/docs/data/charts/heat-map/heat-map.md b/docs/data/charts/heat-map/heat-map.md index c1bcf9ceb36c3..e94a3ed398abc 100644 --- a/docs/data/charts/heat-map/heat-map.md +++ b/docs/data/charts/heat-map/heat-map.md @@ -2,7 +2,7 @@ title: React Heat map chart --- -# Charts - Heat map +# Charts - Heat map 🚧

Heat map charts allow to highlight correlation between categories.

diff --git a/docs/data/charts/radar/radar.md b/docs/data/charts/radar/radar.md index 620aff31d2f1d..26b7fae5115e7 100644 --- a/docs/data/charts/radar/radar.md +++ b/docs/data/charts/radar/radar.md @@ -2,7 +2,7 @@ title: React Radar chart --- -# Charts - Radar +# Charts - Radar 🚧

Radar allows to compare multivariate data in a 2D chart.

diff --git a/docs/data/charts/sankey/sankey.md b/docs/data/charts/sankey/sankey.md index 4f27296cf1ccb..f828c78cb3e04 100644 --- a/docs/data/charts/sankey/sankey.md +++ b/docs/data/charts/sankey/sankey.md @@ -2,7 +2,7 @@ title: React Sankey chart --- -# Charts - Sankey [](/x/introduction/licensing/#pro-plan 'Pro plan') +# Charts - Sankey [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Sankey charts are great for visualizing flows between different elements.

diff --git a/docs/data/charts/tree-map/tree-map.md b/docs/data/charts/tree-map/tree-map.md index d8a116c9584bb..d340add7da127 100644 --- a/docs/data/charts/tree-map/tree-map.md +++ b/docs/data/charts/tree-map/tree-map.md @@ -2,7 +2,7 @@ title: React Tree map chart --- -# Charts - Treemap +# Charts - Treemap 🚧

Treemap allows to display data with a hierarchical structure.

diff --git a/docs/data/data-grid/server-side-data/aggregation.md b/docs/data/data-grid/server-side-data/aggregation.md index 3836a25e9ed5a..fdbaf839ca6f2 100644 --- a/docs/data/data-grid/server-side-data/aggregation.md +++ b/docs/data/data-grid/server-side-data/aggregation.md @@ -2,7 +2,7 @@ title: React Server-side row grouping --- -# Data Grid - Server-side aggregation 🚧 +# Data Grid - Server-side aggregation [](/x/introduction/licensing/#premium-plan 'Premium plan')🚧

Aggregation with server side data source.

diff --git a/docs/data/data-grid/server-side-data/index.md b/docs/data/data-grid/server-side-data/index.md index f235a05581833..c19f3f42f0d5f 100644 --- a/docs/data/data-grid/server-side-data/index.md +++ b/docs/data/data-grid/server-side-data/index.md @@ -2,9 +2,9 @@ title: React Data Grid - Server-side data --- -# Data Grid - Server-side data +# Data Grid - Server-side data 🚧 -

The data grid server-side data

+

The data grid server-side data.

## Overview @@ -98,7 +98,7 @@ interface DataSource { Fetcher Functions: - `getRows` is required - `updateRow` is optional - + `getRows` will be used by the grid to fetch data for the current page or children for the current parent group It may return a `rowCount` to update the total count of rows in the grid */ diff --git a/docs/data/data-grid/server-side-data/infinite-loading.md b/docs/data/data-grid/server-side-data/infinite-loading.md index 6c2533f51fad1..c317a2bb4fd25 100644 --- a/docs/data/data-grid/server-side-data/infinite-loading.md +++ b/docs/data/data-grid/server-side-data/infinite-loading.md @@ -2,7 +2,7 @@ title: React Server-side infinite loading --- -# Data Grid - Server-side infinite loading 🚧 +# Data Grid - Server-side infinite loading [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Row infinite loading with server side data source.

diff --git a/docs/data/data-grid/server-side-data/lazy-loading.md b/docs/data/data-grid/server-side-data/lazy-loading.md index a8430737d67d9..849d0c9ba7212 100644 --- a/docs/data/data-grid/server-side-data/lazy-loading.md +++ b/docs/data/data-grid/server-side-data/lazy-loading.md @@ -2,7 +2,7 @@ title: React Server-side lazy loading --- -# Data Grid - Server-side lazy loading 🚧 +# Data Grid - Server-side lazy loading [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Row lazy-loading with server side data source.

diff --git a/docs/data/data-grid/server-side-data/row-grouping.md b/docs/data/data-grid/server-side-data/row-grouping.md index 72fd21756bc29..3dd487f34f27a 100644 --- a/docs/data/data-grid/server-side-data/row-grouping.md +++ b/docs/data/data-grid/server-side-data/row-grouping.md @@ -2,7 +2,7 @@ title: React Server-side row grouping --- -# Data Grid - Server-side row grouping 🚧 +# Data Grid - Server-side row grouping [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Lazy-loaded row grouping with server side data source.

diff --git a/docs/data/data-grid/server-side-data/tree-data.md b/docs/data/data-grid/server-side-data/tree-data.md index ed69e9ac25d30..7ce5524f9c16a 100644 --- a/docs/data/data-grid/server-side-data/tree-data.md +++ b/docs/data/data-grid/server-side-data/tree-data.md @@ -2,7 +2,7 @@ title: React Server-side tree data --- -# Data Grid - Server-side tree data 🚧 +# Data Grid - Server-side tree data [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧

Tree data lazy-loading with server side data source.

diff --git a/docs/data/pages.ts b/docs/data/pages.ts index b0c88afda4fa8..dce8deb6a8eae 100644 --- a/docs/data/pages.ts +++ b/docs/data/pages.ts @@ -51,7 +51,7 @@ const pages: MuiPage[] = [ { pathname: '/x/react-data-grid/row-definition' }, { pathname: '/x/react-data-grid/row-updates' }, { pathname: '/x/react-data-grid/row-height' }, - { pathname: '/x/react-data-grid/row-spanning', title: 'Row spanning 🚧' }, + { pathname: '/x/react-data-grid/row-spanning', title: 'Row spanning', planned: true }, { pathname: '/x/react-data-grid/master-detail', plan: 'pro' }, { pathname: '/x/react-data-grid/row-ordering', plan: 'pro' }, { pathname: '/x/react-data-grid/row-pinning', plan: 'pro' }, @@ -109,39 +109,49 @@ const pages: MuiPage[] = [ { pathname: '/x/react-data-grid/tree-data', plan: 'pro' }, { pathname: '/x/react-data-grid/row-grouping', plan: 'premium' }, { pathname: '/x/react-data-grid/aggregation', title: 'Aggregation', plan: 'premium' }, - { pathname: '/x/react-data-grid/pivoting', title: 'Pivoting 🚧', plan: 'premium' }, + { + pathname: '/x/react-data-grid/pivoting', + title: 'Pivoting', + plan: 'premium', + planned: true, + }, ], }, { pathname: '/x/react-data-grid/server-side-data-group', - title: 'Server-side data 🚧', - plan: 'pro', + title: 'Server-side data', + planned: true, children: [ - { pathname: '/x/react-data-grid/server-side-data', title: 'Overview' }, + { pathname: '/x/react-data-grid/server-side-data', title: 'Overview', planned: true }, { pathname: '/x/react-data-grid/server-side-data/lazy-loading', - title: 'Lazy loading 🚧', + title: 'Lazy loading', plan: 'pro', + planned: true, }, { pathname: '/x/react-data-grid/server-side-data/infinite-loading', - title: 'Infinite loading 🚧', + title: 'Infinite loading', plan: 'pro', + planned: true, }, { pathname: '/x/react-data-grid/server-side-data/tree-data', - title: 'Tree data 🚧', + title: 'Tree data', plan: 'pro', + planned: true, }, { pathname: '/x/react-data-grid/server-side-data/row-grouping', - title: 'Row grouping 🚧', + title: 'Row grouping', plan: 'pro', + planned: true, }, { pathname: '/x/react-data-grid/server-side-data/aggregation', - title: 'Aggregation 🚧', + title: 'Aggregation', plan: 'premium', + planned: true, }, ], }, diff --git a/packages/grid/x-data-grid-pro/src/models/dataSource.ts b/packages/grid/x-data-grid-pro/src/models/dataSource.ts index e6dc9236529e9..3818c77a72011 100644 --- a/packages/grid/x-data-grid-pro/src/models/dataSource.ts +++ b/packages/grid/x-data-grid-pro/src/models/dataSource.ts @@ -10,38 +10,38 @@ interface GetRowsParams { sortModel: GridSortModel; filterModel: GridFilterModel; /** - * Alternate to `start` and `end`, maps to `GridPaginationModel` interface + * Alternate to `start` and `end`, maps to `GridPaginationModel` interface. */ paginationModel: GridPaginationModel; /** - * First row index to fetch (number) or cursor information (number | string) + * First row index to fetch (number) or cursor information (number | string). */ - start: number | string; // first row index to fetch or cursor information + start: number | string; /** - * Last row index to fetch + * Last row index to fetch. */ end: number; // last row index to fetch /** * Array of keys returned by `getGroupKey` of all the parent rows until the row for which the data is requested - * `getGroupKey` prop must be implemented to use this - * Useful for `treeData` and `rowGrouping` only + * `getGroupKey` prop must be implemented to use this. + * Useful for `treeData` and `rowGrouping` only. */ groupKeys: string[]; /** - * List of grouped columns (only applicable with `rowGrouping`) + * List of grouped columns (only applicable with `rowGrouping`). */ - groupFields: GridColDef['field'][]; // list of grouped columns (`rowGrouping`) + groupFields: GridColDef['field'][]; } interface GetRowsResponse { rows: GridRowModel[]; /** - * To reflect updates in total `rowCount` (optional) - * Useful when the `rowCount` is inaccurate (e.g. when filtering) or not available upfront + * To reflect updates in total `rowCount` (optional). + * Useful when the `rowCount` is inaccurate (e.g. when filtering) or not available upfront. */ rowCount?: number; /** - * Additional `pageInfo` to help the grid determine if there are more rows to fetch (corner-cases) + * Additional `pageInfo` to help the grid determine if there are more rows to fetch (corner-cases). * `hasNextPage`: When row count is unknown/inaccurate, if `truncated` is set or rowCount is not known, data will keep loading until `hasNextPage` is `false` * `truncated`: To reflect `rowCount` is inaccurate (will trigger `x-y of many` in pagination after the count of rows fetched is greater than provided `rowCount`) * It could be useful with: @@ -60,13 +60,13 @@ interface GetRowsResponse { export interface DataSource { /** - Fetcher Functions: - - `getRows` is required - - `updateRow` is optional - - `getRows` will be used by the grid to fetch data for the current page or children for the current parent group - It may return a `rowCount` to update the total count of rows in the grid along with the optional `pageInfo` - */ + * Fetcher Functions: + * - `getRows` is required + * - `updateRow` is optional + * + * `getRows` will be used by the grid to fetch data for the current page or children for the current parent group. + * It may return a `rowCount` to update the total count of rows in the grid along with the optional `pageInfo`. + */ getRows(params: GetRowsParams): Promise; updateRow?(rows: GridRowModel): Promise; }