jsl-ui 9.28.2 → 9.28.3

package/lib/grid/slick.grid.d.ts

@@ -1,285 +1,285 @@
-/**
- * @license
- * (c) 2009-2016 Michael Leibman
- * michael{dot}leibman{at}gmail{dot}com
- * http://github.com/mleibman/slickgrid
- *
- * Distributed under MIT license.
- * All rights reserved.
- *
- * SlickGrid v2.4
- */
-import { ISlickColumn, ISlickFormatter, ISlickEvent } from "./slick.core";
-import "./slick.grid.css";
-import "./slick-default-theme.css";
-export interface ISlickGridOptions {
-    syncColumnCellResize?: boolean;
-    alwaysShowVerticalScroll?: boolean;
-    alwaysShowHorizontalScroll?: boolean;
-    alwaysAllowHorizontalScroll?: boolean;
-    explicitInitialization?: boolean;
-    rowHeight?: number;
-    defaultColumnWidth?: number;
-    enableAddRow?: boolean;
-    leaveSpaceForNewRows?: boolean;
-    editable?: boolean;
-    autoEdit?: boolean;
-    suppressActiveCellChangeOnEdit?: boolean;
-    enableCellNavigation?: boolean;
-    enableColumnReorder?: boolean;
-    asyncEditorLoading?: boolean;
-    asyncEditorLoadDelay?: number;
-    forceFitColumns?: boolean;
-    enableAsyncPostRender?: boolean;
-    asyncPostRenderDelay?: number;
-    enableAsyncPostRenderCleanup?: boolean;
-    asyncPostRenderCleanupDelay?: number;
-    autoHeight?: boolean;
-    editorLock?: any;
-    showHeaderRow?: boolean;
-    headerRowHeight?: number;
-    createFooterRow?: boolean;
-    showFooterRow?: boolean;
-    footerRowHeight?: number;
-    createPreHeaderPanel?: boolean;
-    showPreHeaderPanel?: boolean;
-    preHeaderPanelHeight?: number;
-    showTopPanel?: boolean;
-    topPanelHeight?: number;
-    formatterFactory?: {
-        getFormatter: (column: ISlickColumn, row?: number) => ISlickFormatter;
-    };
-    editorFactory?: {
-        getEditor: (column: ISlickColumn, row?: number) => any;
-    };
-    cellFlashingCssClass?: string;
-    selectedCellCssClass?: string;
-    multiSelect?: boolean;
-    enableTextSelectionOnCells?: boolean;
-    dataItemColumnValueExtractor?: (item: any, columnDef: ISlickColumn) => any;
-    frozenBottom?: boolean;
-    frozenColumn?: number;
-    frozenRow?: number;
-    fullWidthRows?: boolean;
-    multiColumnSort?: boolean;
-    numberedMultiColumnSort?: boolean;
-    tristateMultiColumnSort?: boolean;
-    sortColNumberInSeparateSpan?: boolean;
-    defaultFormatter?: ISlickFormatter;
-    forceSyncScrolling?: boolean;
-    addNewRowCssClass?: string;
-    preserveCopiedSelectionOnPaste?: boolean;
-    showCellSelection?: boolean;
-    viewportClass?: string;
-    minRowBuffer?: number;
-    emulatePagingWhenScrolling?: boolean;
-    editorCellNavOnLRKeys?: boolean;
-    doPaging?: boolean;
-    resizeHandleWidth?: string;
-    variableRowHeight?: boolean;
-    editCommandHandler?: (item: any, column: ISlickColumn, editCommand: any) => void;
-    resizeDelta?: number;
-    dragDelta?: number;
-    enableSingleWordSelection?: boolean;
-}
-export interface ISlickGrid<T> {
-    "slickGridVersion": string;
-    "onScroll": ISlickEvent<{
-        scrollLeft: number;
-        scrollTop: number;
-    }>;
-    "onSort": ISlickEvent<{
-        multiColumnSort: boolean;
-        columnId?: string;
-        sortCol?: ISlickColumn;
-        sortAsc?: boolean;
-        sortCols?: Array<{
-            columnId?: string;
-            sortCol?: ISlickColumn;
-            sortAsc?: boolean;
-        }>;
-    }>;
-    "onAppendRow": ISlickEvent<{
-        row: number;
-        item: T;
-    }>;
-    "onBeforeRemoveRow": ISlickEvent<{
-        row: number;
-        dom: HTMLDivElement;
-    }>;
-    "onClick": ISlickEvent<{
-        row: number;
-        cell: number;
-    }>;
-    "onDblClick": ISlickEvent<{
-        row: number;
-        cell: number;
-    }>;
-    "onColumnsResized": ISlickEvent<{
-        cell: number;
-        width: number;
-        previousWidth: number;
-        column: ISlickColumn;
-    }[]>;
-    "onAppendCell": ISlickEvent<{
-        row: number;
-        cell: number;
-        value: any;
-        item: T;
-        column: ISlickColumn;
-        dom: HTMLDivElement;
-    }>;
-    "onCellChange": ISlickEvent<{
-        row: number;
-        cell: number;
-        item: T;
-        value: any;
-    }>;
-    "onAddNewRow": ISlickEvent<{
-        item: T;
-        column: ISlickColumn;
-    }>;
-    "onHeaderRowCellRendered": ISlickEvent<{
-        node: HTMLElement;
-        column: ISlickColumn;
-        grid: ISlickGrid<T>;
-    }>;
-    "onFooterRowCellRendered": ISlickEvent<{
-        node: HTMLElement;
-        column: ISlickColumn;
-        grid: ISlickGrid<T>;
-    }>;
-    "onHeaderCellRendered": ISlickEvent<{
-        node: HTMLElement;
-        column: ISlickColumn;
-        grid: ISlickGrid<T>;
-    }>;
-    "onBeforeEditCell": ISlickEvent<{
-        row: number;
-        cell: number;
-        item: T;
-        column: ISlickColumn;
-    }>;
-    "onSelectedRowsChanged": ISlickEvent<{
-        rows: number[];
-    }>;
-    "onBeforeDestroy": ISlickEvent<any>;
-    "onColumnsReordered": ISlickEvent<any>;
-    "onViewportChanged": ISlickEvent<any>;
-    "onActiveCellChanged": ISlickEvent<{
-        row: number;
-        cell: number;
-    }>;
-    "onDragInit": ISlickEvent<any>;
-    "onDragStart": ISlickEvent<any>;
-    "onDrag": ISlickEvent<any>;
-    "onDragEnd": ISlickEvent<any>;
-    "registerPlugin": (plugin: any) => void;
-    "init": () => void;
-    "resizeCanvas": () => void;
-    "invalidate": () => void;
-    "invalidateAllRows": () => void;
-    "updateRow": (row: number) => void;
-    "getColumns": () => ISlickColumn[];
-    "setColumns": (columns: ISlickColumn[]) => void;
-    "getSelectedRows": () => number[];
-    "setSelectedRows": (rows: number[]) => void;
-    "invalidateRows": (rows: number[]) => void;
-    "render": () => void;
-    "updateRowCount": () => void;
-    "getColumnIndex": (columnId: string) => number;
-    "scrollRowIntoView": (row: number, doPaging?: boolean) => void;
-    "flashCell": (row: number, cell: number, speed?: number, times?: number) => void;
-    "getActiveCell": () => {
-        row: number;
-        cell: number;
-    };
-    "setActiveCell": (row: number, cell: number, opt_editMode?: boolean, preClickModeOn?: boolean, suppressActiveCellChangedEvent?: boolean) => void;
-    "gotoCell": (row: number, cell: number, forceEdit?: boolean, e?: any) => void;
-    "destroy": () => void;
-    "getColumnById": (id: string) => ISlickColumn;
-    "getHeaderColumnWidthDiff": () => number;
-    "getPreHeaderPanel": () => HTMLDivElement;
-    "getPreHeaderPanelRight": () => HTMLDivElement;
-    "getHeadersWidth": () => number;
-    "getViewportNode": () => HTMLDivElement;
-    "updateColumnHeader": (columnId: string, title: string, toolTip: string) => void;
-    "setSortColumn": (columnId: string, ascending?: boolean) => void;
-    "setSortColumns": (columns: Array<{
-        columnId: string;
-        ascending?: boolean;
-    }>) => void;
-    "getSortColumns": () => Array<{
-        columnId: string;
-        ascending?: boolean;
-    }>;
-    "autosizeColumns": () => void;
-    "setOptions": (args: ISlickGridOptions, supressRender?: boolean) => void;
-    "getOptions": () => ISlickGridOptions;
-    "scrollRowToTop": (row: number) => void;
-    "scrollCellIntoView": (row: number, cell: number, doPaging?: boolean) => void;
-    "scrollColumnIntoView": (cell: number) => void;
-    "getCellFromPoint": (x: number, y: number) => {
-        row: number;
-        cell: number;
-    };
-    "getCellFromEvent": (e: any, dd: any) => {
-        row: number;
-        cell: number;
-    };
-    "getActiveCellNode": () => HTMLElement;
-    "getDataLength": () => number;
-    "getDataItem": (idx: number) => T;
-    "getSelectionModel": () => any;
-    "setSelectionModel": (model: any) => void;
-    "getContainerNode": () => HTMLDivElement;
-    "getDataItemValueForColumn": (item: T, columnDef: ISlickColumn) => any;
-    "getViewport": (viewPortTop?: number, viewPortLeft?: number) => {
-        top: number;
-        bottom: number;
-        leftPx: number;
-        rightPx: number;
-    };
-    "getRenderedRange": (viewportTop?: number, viewportLeft?: number) => {
-        top: number;
-        bottom: number;
-        leftPx: number;
-        rightPx: number;
-    };
-    "getEditController": () => {
-        commitCurrentEdit: () => boolean;
-        cancelCurrentEdit: () => boolean;
-    };
-    "invalidateRow": (row: number) => void;
-    "getCanvasNode": (columnIdOrIdx?: number, rowIndex?: number) => HTMLElement;
-    "focus": () => void;
-    "getActiveCellPosition": () => {
-        top: number;
-        left: number;
-        bottom: number;
-        right: number;
-        width: number;
-        height: number;
-        visible: boolean;
-    };
-    "resetActiveCell": () => void;
-    "getCellNodeBox": (row: number, cell: number) => {
-        bottom: number;
-        left: number;
-        top: number;
-        right: number;
-        height: number;
-        width: number;
-    };
-    "canCellBeSelected": (row: number, cell: number) => boolean;
-    "getGridPosition": () => {
-        top: number;
-        left: number;
-        bottom: number;
-        right: number;
-        width: number;
-        height: number;
-        visible: boolean;
-    };
-}
-export declare function SlickGrid(container: HTMLDivElement | string, data: any, columns: ISlickColumn[], options: ISlickGridOptions): void;
+/**
+ * @license
+ * (c) 2009-2016 Michael Leibman
+ * michael{dot}leibman{at}gmail{dot}com
+ * http://github.com/mleibman/slickgrid
+ *
+ * Distributed under MIT license.
+ * All rights reserved.
+ *
+ * SlickGrid v2.4
+ */
+import { ISlickColumn, ISlickFormatter, ISlickEvent } from "./slick.core";
+import "./slick.grid.css";
+import "./slick-default-theme.css";
+export interface ISlickGridOptions {
+    syncColumnCellResize?: boolean;
+    alwaysShowVerticalScroll?: boolean;
+    alwaysShowHorizontalScroll?: boolean;
+    alwaysAllowHorizontalScroll?: boolean;
+    explicitInitialization?: boolean;
+    rowHeight?: number;
+    defaultColumnWidth?: number;
+    enableAddRow?: boolean;
+    leaveSpaceForNewRows?: boolean;
+    editable?: boolean;
+    autoEdit?: boolean;
+    suppressActiveCellChangeOnEdit?: boolean;
+    enableCellNavigation?: boolean;
+    enableColumnReorder?: boolean;
+    asyncEditorLoading?: boolean;
+    asyncEditorLoadDelay?: number;
+    forceFitColumns?: boolean;
+    enableAsyncPostRender?: boolean;
+    asyncPostRenderDelay?: number;
+    enableAsyncPostRenderCleanup?: boolean;
+    asyncPostRenderCleanupDelay?: number;
+    autoHeight?: boolean;
+    editorLock?: any;
+    showHeaderRow?: boolean;
+    headerRowHeight?: number;
+    createFooterRow?: boolean;
+    showFooterRow?: boolean;
+    footerRowHeight?: number;
+    createPreHeaderPanel?: boolean;
+    showPreHeaderPanel?: boolean;
+    preHeaderPanelHeight?: number;
+    showTopPanel?: boolean;
+    topPanelHeight?: number;
+    formatterFactory?: {
+        getFormatter: (column: ISlickColumn, row?: number) => ISlickFormatter;
+    };
+    editorFactory?: {
+        getEditor: (column: ISlickColumn, row?: number) => any;
+    };
+    cellFlashingCssClass?: string;
+    selectedCellCssClass?: string;
+    multiSelect?: boolean;
+    enableTextSelectionOnCells?: boolean;
+    dataItemColumnValueExtractor?: (item: any, columnDef: ISlickColumn) => any;
+    frozenBottom?: boolean;
+    frozenColumn?: number;
+    frozenRow?: number;
+    fullWidthRows?: boolean;
+    multiColumnSort?: boolean;
+    numberedMultiColumnSort?: boolean;
+    tristateMultiColumnSort?: boolean;
+    sortColNumberInSeparateSpan?: boolean;
+    defaultFormatter?: ISlickFormatter;
+    forceSyncScrolling?: boolean;
+    addNewRowCssClass?: string;
+    preserveCopiedSelectionOnPaste?: boolean;
+    showCellSelection?: boolean;
+    viewportClass?: string;
+    minRowBuffer?: number;
+    emulatePagingWhenScrolling?: boolean;
+    editorCellNavOnLRKeys?: boolean;
+    doPaging?: boolean;
+    resizeHandleWidth?: string;
+    variableRowHeight?: boolean;
+    editCommandHandler?: (item: any, column: ISlickColumn, editCommand: any) => void;
+    resizeDelta?: number;
+    dragDelta?: number;
+    enableSingleWordSelection?: boolean;
+}
+export interface ISlickGrid<T> {
+    "slickGridVersion": string;
+    "onScroll": ISlickEvent<{
+        scrollLeft: number;
+        scrollTop: number;
+    }>;
+    "onSort": ISlickEvent<{
+        multiColumnSort: boolean;
+        columnId?: string;
+        sortCol?: ISlickColumn;
+        sortAsc?: boolean;
+        sortCols?: Array<{
+            columnId?: string;
+            sortCol?: ISlickColumn;
+            sortAsc?: boolean;
+        }>;
+    }>;
+    "onAppendRow": ISlickEvent<{
+        row: number;
+        item: T;
+    }>;
+    "onBeforeRemoveRow": ISlickEvent<{
+        row: number;
+        dom: HTMLDivElement;
+    }>;
+    "onClick": ISlickEvent<{
+        row: number;
+        cell: number;
+    }>;
+    "onDblClick": ISlickEvent<{
+        row: number;
+        cell: number;
+    }>;
+    "onColumnsResized": ISlickEvent<{
+        cell: number;
+        width: number;
+        previousWidth: number;
+        column: ISlickColumn;
+    }[]>;
+    "onAppendCell": ISlickEvent<{
+        row: number;
+        cell: number;
+        value: any;
+        item: T;
+        column: ISlickColumn;
+        dom: HTMLDivElement;
+    }>;
+    "onCellChange": ISlickEvent<{
+        row: number;
+        cell: number;
+        item: T;
+        value: any;
+    }>;
+    "onAddNewRow": ISlickEvent<{
+        item: T;
+        column: ISlickColumn;
+    }>;
+    "onHeaderRowCellRendered": ISlickEvent<{
+        node: HTMLElement;
+        column: ISlickColumn;
+        grid: ISlickGrid<T>;
+    }>;
+    "onFooterRowCellRendered": ISlickEvent<{
+        node: HTMLElement;
+        column: ISlickColumn;
+        grid: ISlickGrid<T>;
+    }>;
+    "onHeaderCellRendered": ISlickEvent<{
+        node: HTMLElement;
+        column: ISlickColumn;
+        grid: ISlickGrid<T>;
+    }>;
+    "onBeforeEditCell": ISlickEvent<{
+        row: number;
+        cell: number;
+        item: T;
+        column: ISlickColumn;
+    }>;
+    "onSelectedRowsChanged": ISlickEvent<{
+        rows: number[];
+    }>;
+    "onBeforeDestroy": ISlickEvent<any>;
+    "onColumnsReordered": ISlickEvent<any>;
+    "onViewportChanged": ISlickEvent<any>;
+    "onActiveCellChanged": ISlickEvent<{
+        row: number;
+        cell: number;
+    }>;
+    "onDragInit": ISlickEvent<any>;
+    "onDragStart": ISlickEvent<any>;
+    "onDrag": ISlickEvent<any>;
+    "onDragEnd": ISlickEvent<any>;
+    "registerPlugin": (plugin: any) => void;
+    "init": () => void;
+    "resizeCanvas": () => void;
+    "invalidate": () => void;
+    "invalidateAllRows": () => void;
+    "updateRow": (row: number) => void;
+    "getColumns": () => ISlickColumn[];
+    "setColumns": (columns: ISlickColumn[]) => void;
+    "getSelectedRows": () => number[];
+    "setSelectedRows": (rows: number[]) => void;
+    "invalidateRows": (rows: number[]) => void;
+    "render": () => void;
+    "updateRowCount": () => void;
+    "getColumnIndex": (columnId: string) => number;
+    "scrollRowIntoView": (row: number, doPaging?: boolean) => void;
+    "flashCell": (row: number, cell: number, speed?: number, times?: number) => void;
+    "getActiveCell": () => {
+        row: number;
+        cell: number;
+    };
+    "setActiveCell": (row: number, cell: number, opt_editMode?: boolean, preClickModeOn?: boolean, suppressActiveCellChangedEvent?: boolean) => void;
+    "gotoCell": (row: number, cell: number, forceEdit?: boolean, e?: any) => void;
+    "destroy": () => void;
+    "getColumnById": (id: string) => ISlickColumn;
+    "getHeaderColumnWidthDiff": () => number;
+    "getPreHeaderPanel": () => HTMLDivElement;
+    "getPreHeaderPanelRight": () => HTMLDivElement;
+    "getHeadersWidth": () => number;
+    "getViewportNode": () => HTMLDivElement;
+    "updateColumnHeader": (columnId: string, title: string, toolTip: string) => void;
+    "setSortColumn": (columnId: string, ascending?: boolean) => void;
+    "setSortColumns": (columns: Array<{
+        columnId: string;
+        ascending?: boolean;
+    }>) => void;
+    "getSortColumns": () => Array<{
+        columnId: string;
+        ascending?: boolean;
+    }>;
+    "autosizeColumns": () => void;
+    "setOptions": (args: ISlickGridOptions, supressRender?: boolean) => void;
+    "getOptions": () => ISlickGridOptions;
+    "scrollRowToTop": (row: number) => void;
+    "scrollCellIntoView": (row: number, cell: number, doPaging?: boolean) => void;
+    "scrollColumnIntoView": (cell: number) => void;
+    "getCellFromPoint": (x: number, y: number) => {
+        row: number;
+        cell: number;
+    };
+    "getCellFromEvent": (e: any, dd: any) => {
+        row: number;
+        cell: number;
+    };
+    "getActiveCellNode": () => HTMLElement;
+    "getDataLength": () => number;
+    "getDataItem": (idx: number) => T;
+    "getSelectionModel": () => any;
+    "setSelectionModel": (model: any) => void;
+    "getContainerNode": () => HTMLDivElement;
+    "getDataItemValueForColumn": (item: T, columnDef: ISlickColumn) => any;
+    "getViewport": (viewPortTop?: number, viewPortLeft?: number) => {
+        top: number;
+        bottom: number;
+        leftPx: number;
+        rightPx: number;
+    };
+    "getRenderedRange": (viewportTop?: number, viewportLeft?: number) => {
+        top: number;
+        bottom: number;
+        leftPx: number;
+        rightPx: number;
+    };
+    "getEditController": () => {
+        commitCurrentEdit: () => boolean;
+        cancelCurrentEdit: () => boolean;
+    };
+    "invalidateRow": (row: number) => void;
+    "getCanvasNode": (columnIdOrIdx?: number, rowIndex?: number) => HTMLElement;
+    "focus": () => void;
+    "getActiveCellPosition": () => {
+        top: number;
+        left: number;
+        bottom: number;
+        right: number;
+        width: number;
+        height: number;
+        visible: boolean;
+    };
+    "resetActiveCell": () => void;
+    "getCellNodeBox": (row: number, cell: number) => {
+        bottom: number;
+        left: number;
+        top: number;
+        right: number;
+        height: number;
+        width: number;
+    };
+    "canCellBeSelected": (row: number, cell: number) => boolean;
+    "getGridPosition": () => {
+        top: number;
+        left: number;
+        bottom: number;
+        right: number;
+        width: number;
+        height: number;
+        visible: boolean;
+    };
+}
+export declare function SlickGrid(container: HTMLDivElement | string, data: any, columns: ISlickColumn[], options: ISlickGridOptions): void;