@revolist/revogrid 4.0.2-next → 4.0.2

package/dist/types/components/overlay/revogr-overlay-selection.d.ts

@@ -1,79 +1,220 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-import { Edition, Observable, RevoGrid, Selection } from '../../interfaces';
-import ColumnService from '../data/columnService';
+import ColumnService from '../data/column.service';
 import SelectionStoreService from '../../store/selection/selection.store.service';
-import { DataSourceState } from '../../store/dataSource/data.store';
+import { DSourceState } from '../../store/dataSource/data.store';
+import { Observable, SelectionStoreState, DimensionSettingsState, DataType, DimensionRows, ColumnRegular, DimensionCols, Cell, DragStartEvent } from '../../components';
+import { MultiDimensionType } from '../../types/dimension';
+import { FocusRenderEvent, ApplyFocusEvent, AllDimensionType } from '../../types/interfaces';
+import { Editors, BeforeSaveDataDetails, BeforeEdit, RangeArea, TempRange, ChangedRange, BeforeRangeSaveDataDetails, SaveDataDetails } from '../../types/selection';
 export declare class OverlaySelection {
-  protected columnService: ColumnService;
-  protected selectionStoreService: SelectionStoreService;
-  private keyboardService;
-  private autoFillService;
-  private clipboardService;
-  private orderEditor;
-  element: HTMLElement;
-  readonly: boolean;
-  range: boolean;
-  canDrag: boolean;
-  useClipboard: boolean;
-  /** Dynamic stores */
-  selectionStore: Observable<Selection.SelectionStoreState>;
-  dimensionRow: Observable<RevoGrid.DimensionSettingsState>;
-  dimensionCol: Observable<RevoGrid.DimensionSettingsState>;
-  /** Static stores, not expected to change during component lifetime */
-  dataStore: Observable<DataSourceState<RevoGrid.DataType, RevoGrid.DimensionRows>>;
-  colData: Observable<DataSourceState<RevoGrid.ColumnRegular, RevoGrid.DimensionCols>>;
-  /** Last cell position */
-  lastCell: Selection.Cell;
-  /** Custom editors register */
-  editors: Edition.Editors;
-  internalCopy: EventEmitter;
-  internalPaste: EventEmitter;
-  internalCellEdit: EventEmitter<Edition.BeforeSaveDataDetails>;
-  internalFocusCell: EventEmitter<Edition.BeforeSaveDataDetails>;
-  setEdit: EventEmitter<Edition.BeforeEdit>;
-  setRange: EventEmitter<Selection.RangeArea>;
-  setTempRange: EventEmitter<Selection.TempRange | null>;
-  focusCell: EventEmitter<Selection.FocusedCells>;
-  /** Selection range changed */
-  internalSelectionChanged: EventEmitter<Selection.ChangedRange>;
-  /** Range data apply */
-  internalRangeDataApply: EventEmitter<Edition.BeforeRangeSaveDataDetails>;
-  onMouseMove(e: MouseEvent): void;
-  /** Pointer left document, clear any active operation */
-  onMouseOut(): void;
-  /** Action finished inside of the document */
-  onMouseUp(): void;
-  /** Row drag started */
-  onCellDrag(e: CustomEvent<MouseEvent>): void;
-  /** Recived keyboard down from element */
-  onKeyUp(e: KeyboardEvent): void;
-  /** Recived keyboard down from element */
-  onKeyDown(e: KeyboardEvent): void;
-  /** Create selection store */
-  selectionServiceSet(s: Observable<Selection.SelectionStoreState>): void;
-  createAutoFillService(): void;
-  columnServiceSet(): void;
-  createClipboardService(): void;
-  connectedCallback(): void;
-  disconnectedCallback(): void;
-  private renderRange;
-  private renderEditCell;
-  render(): any;
-  protected onElementMouseDown(e: MouseEvent): void;
-  protected doEdit(val?: string, isCancel?: boolean): void;
-  private closeEdit;
-  private focusNext;
-  protected clearCell(): void;
-  /** Edit finished, close cell and save */
-  protected onCellEdit(e: Edition.SaveDataDetails, clear?: boolean): void;
-  private onRowDragStart;
-  /** Check if edit possible */
-  protected canEdit(): boolean;
-  /** Collect data from element */
-  protected getData(): {
-    el: HTMLElement;
-    rows: RevoGrid.DimensionSettingsState;
-    cols: RevoGrid.DimensionSettingsState;
-    lastCell: Selection.Cell;
-  };
+    /**
+     * Readonly mode.
+     */
+    readonly: boolean;
+    /**
+     * Range selection allowed.
+     */
+    range: boolean;
+    /**
+     * Enable revogr-order-editor component (read more in revogr-order-editor component).
+     * Allows D&D.
+     */
+    canDrag: boolean;
+    /**
+     * Enable revogr-clipboard component (read more in revogr-clipboard component).
+     * Allows copy/paste.
+     */
+    useClipboard: boolean;
+    /** Stores */
+    /** Selection, range, focus. */
+    selectionStore: Observable<SelectionStoreState>;
+    /** Dimension settings Y. */
+    dimensionRow: Observable<DimensionSettingsState>;
+    /** Dimension settings X. */
+    dimensionCol: Observable<DimensionSettingsState>;
+    /**
+     * Row data store.
+     */
+    dataStore: Observable<DSourceState<DataType, DimensionRows>>;
+    /**
+     * Column data store.
+     */
+    colData: Observable<DSourceState<ColumnRegular, DimensionCols>>;
+    /**
+     * Last cell position.
+     */
+    lastCell: Cell;
+    /**
+     * Custom editors register.
+     */
+    editors: Editors;
+    /**
+     * If true applys changes when cell closes if not Escape.
+     */
+    applyChangesOnClose: boolean;
+    /**
+     * Additional data to pass to renderer.
+     */
+    additionalData: any;
+    /**
+     * Is mobile view mode.
+     */
+    isMobileDevice: boolean;
+    /**
+     * Before clipboard copy happened. Validate data before copy.
+     * To prevent the default behavior of editing data and use your own implementation, call `e.preventDefault()`.
+     */
+    beforeCopyRegion: EventEmitter;
+    /**
+     * Before region paste happened.
+     */
+    beforeRegionPaste: EventEmitter;
+    /**
+     * Cell edit apply to the data source.
+     * Triggers datasource edit on the root level.
+     */
+    cellEditApply: EventEmitter<BeforeSaveDataDetails>;
+    /**
+     * Before cell focus.
+     */
+    beforeFocusCell: EventEmitter<BeforeSaveDataDetails>;
+    /**
+     * Set edit cell.
+     */
+    setEdit: EventEmitter<BeforeEdit>;
+    /**
+     * Before range applied.
+     */
+    beforeApplyRange: EventEmitter<FocusRenderEvent>;
+    /**
+     * Before range selection applied.
+     */
+    beforeSetRange: EventEmitter;
+    /**
+     * Before editor render.
+     */
+    beforeEditRender: EventEmitter<FocusRenderEvent>;
+    /**
+     * Set range.
+     */
+    setRange: EventEmitter<RangeArea & {
+        type: MultiDimensionType;
+    }>;
+    /** Select all. */
+    selectAll: EventEmitter;
+    /**
+     * Used for editors support when editor close requested.
+     */
+    cancelEdit: EventEmitter;
+    /**
+     * Set temp range area during autofill.
+     */
+    setTempRange: EventEmitter<TempRange | null>;
+    /**
+     * Before cell get focused.
+     * To prevent the default behavior of applying the edit data, you can call `e.preventDefault()`.
+     */
+    applyFocus: EventEmitter<FocusRenderEvent>;
+    /**
+     * Cell get focused.
+     * To prevent the default behavior of applying the edit data, you can call `e.preventDefault()`.
+     */
+    focusCell: EventEmitter<ApplyFocusEvent>;
+    /** Range data apply. */
+    beforeRangeDataApply: EventEmitter<FocusRenderEvent>;
+    /** Selection range changed. */
+    selectionChange: EventEmitter<ChangedRange>;
+    /** Before range copy. */
+    beforeRangeCopyApply: EventEmitter<ChangedRange>;
+    /** Range data apply.
+     * Triggers datasource edit on the root level.
+     */
+    rangeEditApply: EventEmitter<BeforeRangeSaveDataDetails>;
+    /** Range copy. */
+    rangeClipboardCopy: EventEmitter;
+    rangeClipboardPaste: EventEmitter;
+    /**
+     * Before key up event proxy, used to prevent key up trigger.
+     * If you have some custom behaviour event, use this event to check if it wasn't processed by internal logic.
+     * Call preventDefault().
+     */
+    beforeKeyDown: EventEmitter<KeyboardEvent>;
+    /**
+     * Before key down event proxy, used to prevent key down trigger.
+     * If you have some custom behaviour event, use this event to check if it wasn't processed by internal logic.
+     * Call preventDefault().
+     */
+    beforeKeyUp: EventEmitter<KeyboardEvent>;
+    /**
+     * Runs before cell save.
+     * Can be used to override or cancel original save.
+     */
+    beforeCellSave: EventEmitter;
+    element: HTMLElement;
+    private clipboard;
+    protected columnService: ColumnService;
+    protected selectionStoreService: SelectionStoreService;
+    private keyboardService;
+    private autoFillService;
+    private orderEditor;
+    private revogrEdit;
+    onMouseMove(e: MouseEvent | TouchEvent): void;
+    /** Action finished inside of the document. */
+    /** Pointer left document, clear any active operation. */
+    onMouseUp(): void;
+    /** Row drag started. */
+    onCellDrag(e: CustomEvent<DragStartEvent>): void;
+    /** Get keyboard down from element. */
+    onKeyUp(e: KeyboardEvent): void;
+    /** Get keyboard down from element. */
+    onKeyDown(e: KeyboardEvent): void;
+    /** Selection & Keyboard */
+    selectionServiceSet(s: Observable<SelectionStoreState>): void;
+    /** Autofill */
+    createAutoFillService(): void;
+    /** Columns */
+    columnServiceSet(): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    componentWillRender(): Promise<void>;
+    private renderRange;
+    private renderEditor;
+    render(): any;
+    private doFocus;
+    private triggerRangeEvent;
+    protected onElementMouseDown(e: MouseEvent | TouchEvent, touch?: boolean): void;
+    /**
+     * Start cell editing
+     */
+    protected doEdit(val?: string): void;
+    /**
+     * Close editor event triggered
+     * @param details - if requires focus next
+     */
+    private closeEdit;
+    /**
+     * Edit finished.
+     * Close Editor and save.
+     */
+    protected cellEdit(e: SaveDataDetails): void;
+    private getRegion;
+    private onCopy;
+    private onPaste;
+    private focusNext;
+    protected clearCell(): void;
+    private rowDragStart;
+    /**
+     * Verify if edit allowed.
+     */
+    protected canEdit(): boolean;
+    get types(): AllDimensionType;
+    /**
+     * Collect data
+     */
+    protected getData(): {
+        el: HTMLElement;
+        rows: DimensionSettingsState;
+        cols: DimensionSettingsState;
+        lastCell: Cell;
+    };
 }

package/dist/types/components/overlay/selection.utils.d.ts

@@ -1,36 +1,33 @@
-import { Selection, RevoGrid } from '../../interfaces';
-import Cell = Selection.Cell;
-export declare type EventData = {
-  el: HTMLElement;
-  rows: RevoGrid.DimensionSettingsState;
-  cols: RevoGrid.DimensionSettingsState;
-  lastCell: Selection.Cell;
+import { DimensionSettingsState } from '../..';
+import { Cell, RangeArea, RangeAreaCss } from '../..';
+export type EventData = {
+    el: HTMLElement;
+    rows: DimensionSettingsState;
+    cols: DimensionSettingsState;
+    lastCell: Cell;
 };
 /** Calculate cell based on x, y position */
 export declare function getCurrentCell({ x, y }: Cell, { el, rows, cols }: EventData): Cell;
-export declare function getCoordinate(range: Selection.RangeArea, focus: Cell, changes: Partial<Cell>, isMulti?: boolean): {
-  start: {
-    x: number;
-    y: number;
-  };
-  end: {
-    x: number;
-    y: number;
-  };
+export declare function getCoordinate(range: RangeArea, focus: Cell, changes: Partial<Cell>, isMulti?: boolean): {
+    start: {
+        x: number;
+        y: number;
+    };
+    end: {
+        x: number;
+        y: number;
+    };
 };
 /** check if out of range */
 export declare function isAfterLast({ x, y }: Cell, { lastCell }: EventData): boolean;
 /** check if out of range */
 export declare function isBeforeFirst({ x, y }: Cell): boolean;
-/** Compare cells, only 1 coordinate difference is possible */
-export declare function getDirectionCoordinate(initial: Cell, last: Cell): Partial<Cell> | null;
-export declare function getLargestAxis(initial: Cell, last: Cell): Partial<Cell> | null;
-export declare function getCell({ x, y, x1, y1 }: Selection.RangeArea, dimensionRow: RevoGrid.DimensionSettingsState, dimensionCol: RevoGrid.DimensionSettingsState): {
-  left: number;
-  right: number;
-  top: number;
-  bottom: number;
-  width: number;
-  height: number;
+export declare function getCell({ x, y, x1, y1 }: RangeArea, dimensionRow: DimensionSettingsState, dimensionCol: DimensionSettingsState): {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+    width: number;
+    height: number;
 };
-export declare function getElStyle(range: Selection.RangeArea, dimensionRow: RevoGrid.DimensionSettingsState, dimensionCol: RevoGrid.DimensionSettingsState): Selection.RangeAreaCss;
+export declare function getElStyle(range: RangeArea, dimensionRow: DimensionSettingsState, dimensionCol: DimensionSettingsState): RangeAreaCss;

package/dist/types/components/revoGrid/grid.helpers.d.ts

@@ -1,12 +1,17 @@
-import { RevoGrid } from "../../interfaces";
-export declare const rowDefinitionByType: (newVal?: RevoGrid.RowDefinition[]) => Partial<{
-  rowPinStart: {
-    sizes?: Record<number, number>;
-  };
-  rowPinEnd: {
-    sizes?: Record<number, number>;
-  };
-  rgRow: {
-    sizes?: Record<number, number>;
-  };
+import { RowDefinition } from '../..';
+export declare const rowDefinitionByType: (newVal?: RowDefinition[]) => Partial<{
+    rowPinStart: {
+        sizes?: Record<number, number>;
+    };
+    rowPinEnd: {
+        sizes?: Record<number, number>;
+    };
+    rgRow: {
+        sizes?: Record<number, number>;
+    };
+}>;
+export declare const rowDefinitionRemoveByType: (oldVal?: RowDefinition[]) => Partial<{
+    rowPinStart: number[];
+    rowPinEnd: number[];
+    rgRow: number[];
 }>;