@sneat/datagrid 0.27.20 → 0.27.21

package/types/sneat-datagrid.d.ts

@@ -3,30 +3,27 @@ import { AfterViewInit, OnChanges, ElementRef, EventEmitter, SimpleChanges } fro
 import { RowContextMenuSignature, ColumnDefinition, Options } from 'tabulator-tables';
 import { IGridColumn } from '@sneat/grid';
 
-interface IRecordsetColumn {
-    name: string;
-    title?: string;
-    dbType: string;
-}
-interface ITableRef {
-    name: string;
-    schema: string;
-    catalog?: string;
-}
-interface IForeignKey {
-    name: string;
-    columns: string[];
-    refTable: ITableRef;
+/**
+ * A marker rendered unobtrusively in a column's header, e.g. to flag a
+ * semantically-recognised field (a declared or inferred `CustomerId`, etc).
+ * The grid has no semantic logic of its own — it only renders what the
+ * consumer passes here.
+ */
+interface IDataGridColumnMarker {
+    readonly label: string;
+    readonly title?: string;
+    readonly kind?: 'declared' | 'inferred';
 }
-declare class CellPopoverComponent {
-    column?: IRecordsetColumn;
-    value: unknown;
-    fk?: IForeignKey;
-    tab: 'rec' | 'cols' | 'refs';
-    static ɵfac: i0.ɵɵFactoryDeclaration<CellPopoverComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CellPopoverComponent, "sneat-datatug-cell-popover", never, { "column": { "alias": "column"; "required": false; }; "value": { "alias": "value"; "required": false; }; "fk": { "alias": "fk"; "required": false; }; }, {}, never, never, true, never>;
+/** Payload emitted by {@link DataGridComponent.cellSelected}. */
+interface IDataGridCellSelectedEvent {
+    readonly row: unknown;
+    readonly column: {
+        readonly field: string;
+        readonly index: number;
+    };
+    readonly value: unknown;
+    readonly rowData: unknown;
 }
-
 /**
  * This is a wrapper class for the tabulator JS library.
  * For more info see http://tabulator.info
@@ -50,6 +47,29 @@ declare class DataGridComponent implements AfterViewInit, OnChanges {
         row: unknown;
         event?: Event;
     }>;
+    /**
+     * Enables Tabulator's cell/range selection (opt-in; off by default so
+     * existing consumers are unaffected). Mirrors Tabulator's own
+     * `selectableRange` option: `true` for unlimited ranges, or a number to
+     * cap how many ranges can be selected at once. Mutually exclusive with
+     * row selection (`selectable`) — Tabulator disables range selection and
+     * logs a console warning if both are set.
+     */
+    selectableRange?: boolean | number;
+    /**
+     * Small, unobtrusive markers rendered in column headers, keyed by field.
+     * The grid applies no semantic meaning to these — it only renders what
+     * the consumer passes (e.g. a semantic-detection layer flagging a
+     * `CustomerId` column).
+     */
+    columnMarkers?: Record<string, IDataGridColumnMarker>;
+    /**
+     * Emitted when a single cell becomes the active selection, either via a
+     * mouse click (always, regardless of `selectableRange`) or, once
+     * `selectableRange` is enabled, via keyboard arrow-key navigation between
+     * cells. Not emitted for multi-cell range drag-selection.
+     */
+    readonly cellSelected: EventEmitter<IDataGridCellSelectedEvent>;
     private tabulator?;
     selectable?: boolean | number | 'highlight';
     private tabulatorOptions?;
@@ -58,13 +78,25 @@ declare class DataGridComponent implements AfterViewInit, OnChanges {
     ngAfterViewInit(): void;
     private drawTable;
     private createTabulatorGrid;
+    /** column.index is the field's position in the `columns` input array. */
+    private emitCellSelected;
+    private handleRangeChanged;
+    private buildColumnDefinitions;
+    /**
+     * Renders the column's title text plus an unobtrusive marker badge.
+     * Inline styles (rather than a stylesheet) keep this correct regardless
+     * of the host app's CSS and Angular's view encapsulation — Tabulator
+     * renders headers into plain DOM nodes outside the component's template,
+     * which emulated encapsulation would not otherwise scope styles onto.
+     */
+    private buildColumnMarkerTitleFormatter;
     private setTabulatorOptions;
     static ɵfac: i0.ɵɵFactoryDeclaration<DataGridComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DataGridComponent, "sneat-datagrid", never, { "layout": { "alias": "layout"; "required": false; }; "data": { "alias": "data"; "required": false; }; "columns": { "alias": "columns"; "required": false; }; "groupBy": { "alias": "groupBy"; "required": false; }; "height": { "alias": "height"; "required": false; }; "maxHeight": { "alias": "maxHeight"; "required": false; }; "rowContextMenu": { "alias": "rowContextMenu"; "required": false; }; "rowClick": { "alias": "rowClick"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; }, { "rowSelected": "rowSelected"; "rowDeselected": "rowDeselected"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DataGridComponent, "sneat-datagrid", never, { "layout": { "alias": "layout"; "required": false; }; "data": { "alias": "data"; "required": false; }; "columns": { "alias": "columns"; "required": false; }; "groupBy": { "alias": "groupBy"; "required": false; }; "height": { "alias": "height"; "required": false; }; "maxHeight": { "alias": "maxHeight"; "required": false; }; "rowContextMenu": { "alias": "rowContextMenu"; "required": false; }; "rowClick": { "alias": "rowClick"; "required": false; }; "selectableRange": { "alias": "selectableRange"; "required": false; }; "columnMarkers": { "alias": "columnMarkers"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; }, { "rowSelected": "rowSelected"; "rowDeselected": "rowDeselected"; "cellSelected": "cellSelected"; }, never, never, true, never>;
 }
 
 type TabulatorColumn = ColumnDefinition;
 type TabulatorOptions = Options;
 
-export { CellPopoverComponent, DataGridComponent };
-export type { TabulatorColumn, TabulatorOptions };
+export { DataGridComponent };
+export type { IDataGridCellSelectedEvent, IDataGridColumnMarker, TabulatorColumn, TabulatorOptions };