@freegridjs/core 1.9.3 → 1.9.5

package/dist/{types-DloQYCt_.d.ts → types-CIOv3MoN.d.ts}

@@ -846,6 +846,15 @@ interface GridOptions {
      * Ignored with a datasource and while rows are grouped, pivoted or shown as a tree. Default false.
      */
     sortWithinMerges?: boolean;
+    /**
+     * Where the checkboxes go when `merge` columns are shown (needs `rowSelection`). 'rows' (default): one per row.
+     * A number n: one checkbox per block of the n-th merge column, counting the shown columns with `merge` from the left
+     * (system columns and `rowSpan` columns do not count). Blocks nest: a level-2 block ends wherever the first or the
+     * second merge column starts a new merged cell. The checkbox is drawn merged over its block and checks every row of it;
+     * Shift checks the blocks in between. A number above the count of merge columns uses the last one.
+     * Ignored (one checkbox per row) with a datasource and while rows are grouped, pivoted or shown as a tree.
+     */
+    mergeSelection?: 'rows' | number;
     /** A pinned column numbering the data rows 1, 2, 3… (continues across pages). Click a number to select the row. */
     rowNumbers?: boolean | {
         width?: number;
@@ -1071,6 +1080,15 @@ interface GridEvents {
         cancel(): void;
     };
 }
+/** One checked merged block from getSelectedGroups(). */
+interface MergeSelectionGroup {
+    /** The mergeSelection level the block belongs to. */
+    level: number;
+    /** Field → value of merge columns 1..level for the block. */
+    values: Record<string, unknown>;
+    /** Selected rows of the block in display order (every row of the block that passes the filters for getSelectedGroupsAllRows()). */
+    rows: Row[];
+}
 interface GridApi {
     /** Replace all rows. The scroll position stays unless `scrollToTop` is set. */
     setData(rows: Row[], options?: {
@@ -1128,6 +1146,21 @@ interface GridApi {
     /** Turn `sortWithinMerges` on or off; the rows are sorted again at once. */
     setSortWithinMerges(on: boolean): void;
     getSortWithinMerges(): boolean;
+    /** Change `mergeSelection`: 'rows' for one checkbox per row, or the merge level whose blocks get one checkbox. The selected rows stay selected. */
+    setMergeSelection(level: 'rows' | number): void;
+    getMergeSelection(): 'rows' | number;
+    /**
+     * The selected rows by merged block of the `mergeSelection` level, in display order: one entry per block holding
+     * selected rows, with the values of merge columns 1..level (by field, or column id without a field) and the block's
+     * selected rows that pass the filters (for a checked block, all of its selectable rows). [] while mergeSelection is
+     * 'rows' or block checkboxes do not apply.
+     */
+    getSelectedGroups(): MergeSelectionGroup[];
+    /**
+     * Like getSelectedGroups(), but `rows` lists every row of each block that passes the filters, selected or not — for
+     * example to act on a whole company when only some of its rows were ticked. [] while mergeSelection is 'rows'.
+     */
+    getSelectedGroupsAllRows(): MergeSelectionGroup[];
     /** Show the 'loading' or 'noRows' overlay yourself (for example while your own request runs); null goes back to automatic. */
     showOverlay(kind: 'loading' | 'noRows' | null): void;
     /** Print the rows as a table (current sort and filters, group rows and summary rows) on the paper you choose. */
@@ -1268,4 +1301,4 @@ interface GridApi {
     destroy(): void;
 }
 
-export { type SavedStatePart as $, type AdvancedFilter as A, type EditorSpec as B, type CellEvent as C, type Datasource as D, type ExportOptions as E, type FilterModel as F, type GridOptions as G, type FilterOp as H, type FilterType as I, type GridEvents as J, type GridRange as K, type LocalePack as L, type InvalidCell as M, type JsonExportOptions as N, type KeyAction as O, type Messages as P, type NumberFilterModel as Q, type Row as R, type NumberOp as S, type PdfOptions as T, type PivotConfig as U, type PrintOptions as V, type Region as W, type RowDragOptions as X, type RowDropParams as Y, type RowDropPosition as Z, type SavedGridState as _, type GridApi as a, type ScrollPosition as a0, type SelectOption as a1, type ServerParams as a2, type SetFilterModel as a3, type SortDir as a4, type SortItem as a5, type SpanParams as a6, type SummaryCell as a7, type SummaryOptions as a8, type SummaryRowDef as a9, type TextFilterModel as aa, type TextOp as ab, type TransactionResult as ac, type XlsxCell as ad, type XlsxSheet as ae, readXlsx as af, writeXlsx as ag, type RowTransaction as b, type AdvancedFilterCondition as c, type Aggregator as d, type AssistantAction as e, type AssistantColumn as f, type AssistantOptions as g, type AssistantRequest as h, type AssistantResult as i, type CellParams as j, type CellStyle as k, type ChartHandle as l, type ChartOptions as m, type ColumnDef as n, type ColumnState as o, type ColumnType as p, type CombinedFilterModel as q, type ConditionalFormat as r, type ConditionalFormatType as s, type ConditionalOp as t, type ContextMenuItem as u, type ContextMenuParams as v, type CustomEditor as w, type DateFilterModel as x, type DateOp as y, type EditorParams as z };
+export { type SavedGridState as $, type AdvancedFilter as A, type EditorSpec as B, type CellEvent as C, type Datasource as D, type ExportOptions as E, type FilterModel as F, type GridOptions as G, type FilterOp as H, type FilterType as I, type GridEvents as J, type GridRange as K, type LocalePack as L, type InvalidCell as M, type JsonExportOptions as N, type KeyAction as O, type MergeSelectionGroup as P, type Messages as Q, type Row as R, type NumberFilterModel as S, type NumberOp as T, type PdfOptions as U, type PivotConfig as V, type PrintOptions as W, type Region as X, type RowDragOptions as Y, type RowDropParams as Z, type RowDropPosition as _, type GridApi as a, type SavedStatePart as a0, type ScrollPosition as a1, type SelectOption as a2, type ServerParams as a3, type SetFilterModel as a4, type SortDir as a5, type SortItem as a6, type SpanParams as a7, type SummaryCell as a8, type SummaryOptions as a9, type SummaryRowDef as aa, type TextFilterModel as ab, type TextOp as ac, type TransactionResult as ad, type XlsxCell as ae, type XlsxSheet as af, readXlsx as ag, writeXlsx as ah, type RowTransaction as b, type AdvancedFilterCondition as c, type Aggregator as d, type AssistantAction as e, type AssistantColumn as f, type AssistantOptions as g, type AssistantRequest as h, type AssistantResult as i, type CellParams as j, type CellStyle as k, type ChartHandle as l, type ChartOptions as m, type ColumnDef as n, type ColumnState as o, type ColumnType as p, type CombinedFilterModel as q, type ConditionalFormat as r, type ConditionalFormatType as s, type ConditionalOp as t, type ContextMenuItem as u, type ContextMenuParams as v, type CustomEditor as w, type DateFilterModel as x, type DateOp as y, type EditorParams as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freegridjs/core",
-  "version": "1.9.3",
+  "version": "1.9.5",
   "description": "FreeGrid — a fast data grid for the web: virtual scrolling, grouping, pivot, charts, Excel export, 7 languages. Free core; paid features free with a personal key.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",