@revolist/revogrid 4.4.0-next.2 → 4.4.0-next.21

package/dist/types/components/clipboard/revogr-clipboard.d.ts

@@ -1,6 +1,10 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { RevoGrid } from '../../interfaces';
 export declare class Clipboard {
+  /**
+   * If readonly mode enables no need for Paste event
+   */
+  readonly: boolean;
   /**
    * Fired when region pasted
    * @event pasteregion
@@ -71,8 +75,8 @@ export declare class Clipboard {
    */
   copyStarted(e: ClipboardEvent): void;
   /**
- * Listen to copy event and emit copy region event
- */
+   * Listen to copy event and emit copy region event
+   */
   cutStarted(e: ClipboardEvent): void;
   doCopy(e: DataTransfer, data?: RevoGrid.DataFormat[][]): Promise<void>;
   parserCopy(data: RevoGrid.DataFormat[][]): string;

package/dist/types/components/header/headerCellRenderer.d.ts

@@ -1,7 +1,8 @@
 import { VNode } from '../../stencil-public-runtime';
 import { RevoGrid } from '../../interfaces';
+import { ResizeProps } from '../../services/resizable.directive';
 type Props = {
-  props: RevoGrid.CellProps;
+  props: RevoGrid.CellProps & Partial<ResizeProps>;
   additionalData: any;
   data?: RevoGrid.ColumnTemplateProp;
 };

package/dist/types/components/header/headerRenderer.d.ts

@@ -1,6 +1,6 @@
 import { VNode } from '../../stencil-public-runtime';
 import { RevoGrid, Selection } from '../../interfaces';
-import { ResizeEvent } from '../../services/resizable.directive';
+import { ResizeEvent, ResizeProps } from '../../services/resizable.directive';
 type Props = {
   column: RevoGrid.VirtualPositionItem;
   additionalData: any;
@@ -11,6 +11,6 @@ type Props = {
   onResize?(e: ResizeEvent): void;
   onClick?(data: RevoGrid.InitialHeaderClick): void;
   onDoubleClick?(data: RevoGrid.InitialHeaderClick): void;
-};
+} & Partial<Pick<ResizeProps, 'active'>>;
 declare const HeaderRenderer: (p: Props) => VNode;
 export default HeaderRenderer;

package/dist/types/components/header/revogr-header.d.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from '../../stencil-public-runtime';
 import { HTMLStencilElement } from '../../stencil-public-runtime';
 import { Observable, RevoGrid, Selection } from '../../interfaces';
 import { Groups } from '../../store/dataSource/data.store';
+import { ResizeProps } from '../../services/resizable.directive';
 export declare class RevogrHeaderComponent {
   element: HTMLStencilElement;
   viewportCol: Observable<RevoGrid.ViewportState>;
@@ -10,10 +11,23 @@ export declare class RevogrHeaderComponent {
   parent: string;
   groups: Groups;
   groupingDepth: number;
+  /**
+   * If columns can be resized
+   */
   canResize: boolean;
+  /**
+   * Define custom resize position
+   */
+  resizeHandler: ResizeProps['active'];
   colData: RevoGrid.ColumnRegular[];
   columnFilter: boolean;
-  type: string;
+  /**
+   * Column type
+   */
+  type: RevoGrid.DimensionCols | 'rowHeaders';
+  /**
+   * Extra properties to pass into header renderer, such as vue or react components to handle parent
+   */
   additionalData: any;
   initialHeaderClick: EventEmitter<RevoGrid.InitialHeaderClick>;
   headerresize: EventEmitter<RevoGrid.ViewSettingSizeProp>;

package/dist/types/components/overlay/autofill.service.d.ts

@@ -39,9 +39,10 @@ export declare class AutoFillService {
    * @param selectionFocus
    */
   renderAutofill(range: Selection.RangeArea, selectionFocus: Selection.Cell): any;
+  private autoFillHandler;
   get isAutoFill(): boolean;
   /** Process mouse move events */
-  selectionMouseMove(e: MouseEvent & TouchEvent): void;
+  selectionMouseMove(e: MouseEvent | TouchEvent): void;
   private getFocus;
   /**
    * Autofill logic:
@@ -54,7 +55,7 @@ export declare class AutoFillService {
    * Can be triggered from MouseDown selection on element
    * Or can be triggered on corner square drag
    */
-  selectionStart(e: MouseEvent, data: EventData, type?: AutoFillType): void;
+  selectionStart(target: Element, data: EventData, type?: AutoFillType): void;
   /**
    * Clear current range selection
    * on mouse up and mouse leave events
@@ -64,7 +65,10 @@ export declare class AutoFillService {
   onRangeApply(data: RevoGrid.DataLookup, range: Selection.RangeArea): void;
   /** Apply range and copy data during range application */
   private applyRangeWithData;
-  /** Update range selection ony, no data change (mouse selection) */
+  /**
+   * Update range selection only,
+   * no data change (mouse selection)
+   */
   private applyRangeOnly;
 }
 export {};

package/dist/types/components/overlay/clipboard.service.d.ts

@@ -16,7 +16,7 @@ export declare class ClipboardService {
   private sv;
   private clipboard;
   constructor(sv: Config);
-  renderClipboard(): any;
+  renderClipboard(readonly?: boolean): any;
   private getRegion;
   private onCopy;
   private onPaste;

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

@@ -1,18 +1,26 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { Edition, RevoGrid } from '../../interfaces';
+/**
+ * Cell editor component
+ */
 export declare class RevoEdit {
   element: HTMLElement;
   editCell: Edition.EditCell;
   column: RevoGrid.ColumnRegular | null;
   /** Custom editors register */
   editor: Edition.EditorCtr | null;
+  /** Save on editor close */
   saveOnClose: boolean;
+  /** Additional data to pass to renderer */
+  additionalData: any;
+  /** Cell edit event */
   cellEdit: EventEmitter<Edition.SaveDataDetails>;
   /**
    * Close editor event
    * pass true if requires focus next
    */
   closeEdit: EventEmitter<boolean | undefined>;
+  /** Edit session editor */
   private currentEditor;
   private saveRunning;
   cancel(): Promise<void>;

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

@@ -4,13 +4,6 @@ import ColumnService from '../data/columnService';
 import SelectionStoreService from '../../store/selection/selection.store.service';
 import { DataSourceState } from '../../store/dataSource/data.store';
 export declare class OverlaySelection {
-  protected columnService: ColumnService;
-  protected selectionStoreService: SelectionStoreService;
-  private keyboardService;
-  private autoFillService;
-  private clipboardService;
-  private orderEditor;
-  private revogrEdit;
   element: HTMLElement;
   /**
    * If readonly mode enables
@@ -49,12 +42,31 @@ export declare class OverlaySelection {
    * Custom editors register
    */
   editors: Edition.Editors;
-  /** If true applys changes when cell closes if not Escape */
+  /**
+   * 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
+   */
   internalCopy: EventEmitter;
+  /**
+   * Before paste happened
+   */
   internalPaste: EventEmitter;
   internalCellEdit: EventEmitter<Edition.BeforeSaveDataDetails>;
   beforeFocusCell: EventEmitter<Edition.BeforeSaveDataDetails>;
+  /**
+   * Set edit cell
+   */
   setEdit: EventEmitter<Edition.BeforeEdit>;
   beforeApplyRange: EventEmitter<FocusRenderEvent>;
   beforeSetRange: EventEmitter;
@@ -81,12 +93,19 @@ export declare class OverlaySelection {
   /** Range copy */
   rangeClipboardCopy: EventEmitter;
   rangeClipboardPaste: EventEmitter;
+  protected columnService: ColumnService;
+  protected selectionStoreService: SelectionStoreService;
+  private keyboardService;
+  private autoFillService;
+  private clipboardService;
+  private orderEditor;
+  private revogrEdit;
   /**
    * Runs before cell save
    * Can be used to override or cancel original save
    */
   beforeCellSave: EventEmitter;
-  onMouseMove(e: MouseEvent & TouchEvent): void;
+  onMouseMove(e: MouseEvent | TouchEvent): void;
   /** Action finished inside of the document */
   /** Pointer left document, clear any active operation */
   onMouseUp(): void;
@@ -107,7 +126,10 @@ export declare class OverlaySelection {
   render(): any;
   private doFocus;
   private triggerRangeEvent;
-  protected onElementMouseDown(e: MouseEvent): void;
+  protected onElementMouseDown(e: MouseEvent | TouchEvent, touch?: boolean): void;
+  /**
+   * Start cell editing
+   */
   protected doEdit(val?: string): void;
   /**
    * Close editor event triggered

package/dist/types/components/revoGrid/revo-grid.d.ts

@@ -65,9 +65,10 @@ export declare class RevoGridComponent {
    * Every plugin should be inherited from BasePlugin
    */
   plugins: RevoPlugin.PluginClass[];
-  /** Types
+  /** Column Types Format
    *  Every type represent multiple column properties
    *  Types will be merged but can be replaced with column properties
+   *  Types were made as separate objects to be reusable per multiple columns
    */
   columnTypes: {
     [name: string]: RevoGrid.ColumnType;
@@ -253,6 +254,13 @@ export declare class RevoGridComponent {
     type: RevoGrid.DimensionRows;
     source: RevoGrid.DataType[];
   }>;
+  /**
+   * After all rows updated. Use it if you want to track all changes from sources pinned and main
+   */
+  afterAnySource: EventEmitter<{
+    type: RevoGrid.DimensionRows;
+    source: RevoGrid.DataType[];
+  }>;
   /**  Before column update */
   beforecolumnsset: EventEmitter<ColumnCollection>;
   /**  Before column applied but after column set gathered and viewport updated */
@@ -410,8 +418,8 @@ export declare class RevoGridComponent {
    */
   getSelectedRange(): Promise<Selection.RangeArea | null>;
   private clickTrackForFocusClear;
-  mousedownHandle(event: MouseEvent & TouchEvent): void;
-  mouseupHandle(event: MouseEvent & TouchEvent): void;
+  mousedownHandle(event: MouseEvent | TouchEvent): void;
+  mouseupHandle(event: MouseEvent | TouchEvent): void;
   /** DRAG AND DROP */
   onRowDragStarted(e: CustomEvent<{
     pos: RevoGrid.PositionItem;
@@ -447,6 +455,10 @@ export declare class RevoGridComponent {
    */
   private internalPlugins;
   element: HTMLRevoGridElement;
+  /**
+   * Column format change will trigger column structure update
+   */
+  columnTypesChanged(): void;
   columnChanged(newVal?: RevoGrid.ColumnDataSchema[]): void;
   rowSizeChanged(s: number): void;
   themeChanged(t: ThemeSpace.Theme): void;
@@ -466,7 +478,6 @@ export declare class RevoGridComponent {
   applyFilter(cfg: boolean | ColumnFilterConfig): void;
   rowheaderschanged: EventEmitter;
   rowHeadersChange(rowHeaders?: RevoGrid.RowHeaders | boolean): void;
-  private dataSourceApply;
   connectedCallback(): void;
   disconnectedCallback(): void;
   render(): any;

package/dist/types/components/revoGrid/viewport.scrolling.service.d.ts

@@ -1,6 +1,6 @@
 import { RevoGrid } from '../../interfaces';
 export interface ElementScroll {
-  changeScroll?(e: RevoGrid.ViewPortScrollEvent): Promise<RevoGrid.ViewPortScrollEvent>;
+  changeScroll?(e: RevoGrid.ViewPortScrollEvent, silent?: boolean): Promise<RevoGrid.ViewPortScrollEvent>;
   setScroll(e: RevoGrid.ViewPortScrollEvent): Promise<void>;
 }
 export type ElementsScroll = {
@@ -10,7 +10,11 @@ export default class GridScrollingService {
   private setViewport;
   private elements;
   constructor(setViewport: (e: RevoGrid.ViewPortScrollEvent) => void);
-  onScroll(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): Promise<void>;
+  scrollService(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): Promise<void>;
+  /**
+   * Silent scroll update for mobile devices when we have negative scroll top
+   */
+  scrollSilentService(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): Promise<void>;
   private isPinnedColumn;
   registerElements(els: ElementsScroll): void;
   /**

package/dist/types/components/revoGrid/viewport.section.d.ts

@@ -14,7 +14,8 @@ type Props = {
   columnFilter: boolean;
   additionalData: any;
   focusTemplate: RevoGrid.FocusTemplateFunc;
-  onScroll(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): void;
+  scrollSection(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): void;
+  scrollSectionSilent(e: RevoGrid.ViewPortScrollEvent, key?: RevoGrid.DimensionColPin | string): void;
   onCancelEdit(): void;
   onEdit(edit: Edition.BeforeEdit): void;
   onSelectAll(): void;
@@ -25,5 +26,5 @@ type Props = {
  * First we render vertical parts - pinned start, data, pinned end
  * Per each column we render data collections: headers, pinned top, center data, pinned bottom
  */
-export declare const ViewPortSections: ({ resize, editors, rowClass, readonly, range, columns, useClipboard, columnFilter, applyEditorChangesOnClose, additionalData, onCancelEdit, registerElement, onEdit, onScroll, focusTemplate, onSelectAll, }: Props) => VNode[];
+export declare const ViewPortSections: ({ resize, editors, rowClass, readonly, range, columns, useClipboard, columnFilter, applyEditorChangesOnClose, additionalData, onCancelEdit, registerElement, onEdit, scrollSection, focusTemplate, onSelectAll, scrollSectionSilent, }: Props) => VNode[];
 export {};

package/dist/types/components/revoGrid/viewport.service.d.ts

@@ -35,6 +35,7 @@ export default class ViewportService {
   private onColumnResize;
   /**
    * Transform data from stores and apply it to different components
+   * Handle columns
    */
   private getViewportColumnData;
   /** register selection store for Segment */
@@ -54,6 +55,9 @@ export default class ViewportService {
    */
   clearFocused(): void;
   clearEdit(): void;
+  /**
+   * Collect focused element data
+   */
   getFocused(): FocusedData | null;
   getStoreCoordinateByType(colType: RevoGrid.DimensionCols, rowType: RevoGrid.DimensionRows): {
     x: number;

package/dist/types/components/scroll/revogr-viewport-scroll.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { RevoGrid, ScrollCoordinateEvent } from '../../interfaces';
 type Delta = 'deltaX' | 'deltaY';
-type ScrollEvent = {
+type LocalScrollEvent = {
   preventDefault(): void;
 } & {
   [x in Delta]: number;
@@ -16,6 +16,11 @@ export declare class RevogrViewportScroll {
     type: RevoGrid.DimensionType;
     hasScroll: boolean;
   }>;
+  /**
+   * Silently scroll to coordinate
+   * Made to align negative coordinates for mobile devices
+  */
+  silentScroll: EventEmitter<RevoGrid.ViewPortScrollEvent>;
   private scrollThrottling;
   /**
    * Width of inner content
@@ -48,13 +53,19 @@ export declare class RevogrViewportScroll {
    * update on delta in case we don't know existing position or external change
    * @param e
    */
-  changeScroll(e: RevoGrid.ViewPortScrollEvent): Promise<RevoGrid.ViewPortScrollEvent>;
-  mousewheelVertical({ detail: e }: CustomEvent<ScrollEvent>): void;
-  mousewheelHorizontal({ detail: e }: CustomEvent<ScrollEvent>): void;
+  changeScroll(e: RevoGrid.ViewPortScrollEvent, silent?: boolean): Promise<RevoGrid.ViewPortScrollEvent>;
+  /**
+   * Dispatch this event to trigger vertical mouse wheel from plugins
+   */
+  mousewheelVertical({ detail: e, }: CustomEvent<LocalScrollEvent>): void;
+  /**
+   * Dispatch this event to trigger horizontal mouse wheel from plugins
+   */
+  mousewheelHorizontal({ detail: e, }: CustomEvent<LocalScrollEvent>): void;
   /**
    * Allows to use outside listener
    */
-  scrollApply({ detail: { type, coordinate } }: CustomEvent<ScrollCoordinateEvent>): void;
+  scrollApply({ detail: { type, coordinate }, }: CustomEvent<ScrollCoordinateEvent>): void;
   connectedCallback(): void;
   componentDidLoad(): void;
   /**