@svgrid/grid 2.6.2 → 2.6.4

package/dist/SvGrid.types.d.ts

@@ -4,6 +4,7 @@ import type { ConditionalFormat } from "./conditional-formatting";
 import type { GroupDisplayType } from "./group-display";
 import type { GridMessages } from "./grid-messages";
 import type { GridPivotConfig } from "./pivot-view.svelte";
+import type { GridPredicateExpr } from "./filtering/predicate-expr";
 import type { MenuItem } from "./SvMenuList.svelte";
 /** The calendar views the scheduler can render. {@link SchedulerConfig}. The
  *  `timeline*` views are horizontal: time runs left→right and resources are
@@ -1024,6 +1025,44 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
         indentPx?: number;
     };
     groupable?: boolean;
+    /**
+     * Group the rows by these column ids, outermost first - `['region',
+     * 'country']` rolls country up inside region.
+     *
+     * ```svelte
+     * <SvGrid {data} {columns} {features} groupBy={['department']} />
+     * ```
+     *
+     * The prop seeds the group-by list and re-applies whenever it changes, so it
+     * works both as initial state and as a controlled value. The column menu and
+     * `api.setGroupBy()` write the same state; a change from either survives
+     * until this prop's own value changes.
+     *
+     * Ignored when `treeData` is set - a row cannot be both a hierarchy node and
+     * bucketed under a group banner.
+     */
+    groupBy?: ReadonlyArray<string>;
+    /**
+     * Which group / tree rows are expanded, keyed by row id.
+     *
+     * Expansion is owned by the engine by default; pass this prop to hoist it
+     * (saved views, "expand everything on load", persisted UI state). Like
+     * `groupBy` it seeds the state and re-applies whenever it changes.
+     *
+     * Group row ids are built from the grouping path, not the display label:
+     * `group_department_Engineering`, and one level deeper
+     * `group_department_Engineering_role_Senior`. Tree rows key off the engine's
+     * row id instead (set `getRowId` to make that your own id). Prefer capturing
+     * the map from `onExpandedChange` over hand-building these keys.
+     */
+    expanded?: Record<string, boolean>;
+    /**
+     * Fired whenever the expanded set changes - chevron clicks,
+     * `api.setRowExpanded()`, `expandAllGroups()` / `collapseAllGroups()`.
+     * Receives the full next map, so it can be written straight back into
+     * `expanded` for a controlled setup.
+     */
+    onExpandedChange?: (expanded: Record<string, boolean>) => void;
     /**
      * Render a subtotal row after each group's children, carrying that group's
      * aggregate values under the columns they belong to (the columns with an
@@ -1335,6 +1374,28 @@ export type Props<TFeatures extends TableFeatures = TableFeatures, TData extends
         id: string;
         desc: boolean;
     }>;
+    /**
+     * The advanced-filter expression to start in (Pro). Applied once at mount;
+     * change it afterwards through `api.setAdvancedFilter()`.
+     *
+     * Filtering only happens once `@svgrid/enterprise`'s `enableAdvancedFilter()`
+     * has registered a compiler - without it the expression is stored and
+     * reported but no rows are removed, so the free grid degrades to a no-op
+     * rather than to a wrong row set.
+     */
+    initialAdvancedFilter?: GridPredicateExpr | null;
+    /**
+     * Fires whenever the advanced-filter expression changes, whatever changed it:
+     * `api.setAdvancedFilter()`, `clearAllFilters()`, or the toolbar's clear
+     * control.
+     *
+     * The panel that authors the expression is mounted by you, outside the grid,
+     * so it cannot see a change the grid made on its own. Without this, clearing
+     * from the toolbar leaves that panel showing a filter the grid is no longer
+     * applying. Feed this back into the panel's `expression` prop to keep them
+     * agreeing.
+     */
+    onAdvancedFilterChange?: (expr: GridPredicateExpr | null) => void;
     /**
      * When `true`, the grid still records column-filter / global-filter /
      * facet state (so the menu UI works and indicators light up) but does