@progress/kendo-vue-grid 3.5.0 → 3.5.1-dev.202208100944

package/dist/esm/Grid.d.ts

@@ -0,0 +1,180 @@
+declare type DefaultData<V> = object | ((this: V) => GridData);
+declare type DefaultMethods<V> = {
+    [key: string]: (this: V, ...args: any[]) => any;
+};
+import { DefineComponent, RecordPropsDefinition, ComponentOptions, Vue2type } from './additionalTypes';
+import { Page, TableKeyboardNavigationContextType, TableKeyboardNavigationStateType } from '@progress/kendo-vue-data-tools';
+import { ExtendedColumnProps } from './interfaces/ExtendedColumnProps';
+import { SortDescriptor, CompositeFilterDescriptor, GroupDescriptor, State } from '@progress/kendo-data-query';
+import { VirtualScroll } from './VirtualScroll';
+import { ColumnResize } from './drag/ColumnResize';
+import { CommonDragLogic } from './drag/CommonDragLogic';
+import { DataItemWrapper } from './utils/index';
+import { GridProps } from './interfaces/GridProps';
+import { GridColumnProps } from './interfaces/GridColumnProps';
+/**
+ * Represents the [native Vue Grid component by Kendo UI]({% slug overview_grid %}).
+ *
+ * @example
+ * ```tsx-no-run
+ *   <div id="app">
+ *       <Grid
+ *           :data-items="products"
+ *           :columns="columns">
+ *        </Grid>
+ *   </div>
+ *   <script>
+ *       Vue.component('Grid', Grid);
+ *       new Vue({
+ *           el: '#app',
+ *           data: function () {
+ *               return {
+ *                  products: [
+ *                    { 'foo': 'A1', 'bar': 'B1' },
+ *                       { 'foo': 'A2', 'bar': 'B2' },
+ *                       { 'foo': 'A3', 'bar': 'B2' }
+ *                   ],
+ *                   columns: [
+ *                       { field: 'foo'},
+ *                       { field: 'bar'}
+ *                   ]
+ *               };
+ *           }
+ *       });
+ *   </script>
+ * ```
+ */
+/**
+ * @hidden
+ */
+export interface GridMethods {
+    [key: string]: any;
+    getColumns: () => GridColumnProps[];
+    setRefs: () => void;
+    gridUnmounted: () => void;
+    resetVirtual: () => void;
+    onSkipChanged: (value: number, oldValue: number) => void;
+    onTotalChanged: (value: number, oldValue: number) => void;
+    onRowHeightChanged: (value: number, oldValue: number) => void;
+    scrollHandler: (event: any) => void;
+    rowClick: (e: any, item: any) => void;
+    rowDoubleClick: (e: any, item: any) => void;
+    itemChange: (event: {
+        dataItem: any;
+        event: any;
+        field?: string;
+        value?: any;
+    }) => void;
+    cellClickHandler: (event: any) => void;
+    cellKeydownHandler: (event: any) => void;
+    editHandler: (dataItem: any) => void;
+    removeHandler: (dataItem: any) => void;
+    saveHandler: (dataItem: any) => void;
+    cancelHandler: (dataItem: any) => void;
+    selectionChangeHandler: (event: any) => void;
+    onHeaderSelectionChangeHandler: (event: any) => void;
+    pageChangeHandler: (page: Page, event: any) => void;
+    sortChangeHandler: (sort: SortDescriptor[], event: any) => void;
+    filterChangeHandler: (filter: CompositeFilterDescriptor, event: any) => void;
+    groupChangeHandler: (groups: GroupDescriptor[], event: any) => void;
+    raiseDataEvent: (handler: string, data: {}, moreData: State, event: any) => void;
+    columnReorder: (prev: number, next: number, event: any) => void;
+    groupReorder: (prevIndex: number, nextIndex: number, event: any) => void;
+    columnToGroup: (columnIndex: number, groupIndex: number, event: any) => void;
+    resetTableWidth: () => void;
+    onResize: (index: number, newWidth: number, oldWidth: number, event: any, end: boolean) => void;
+    initColumns: (columnElements: GridColumnProps[] | null | undefined, groupCount: number) => void;
+    resolveTitle: (field: string) => string;
+    getDataState: () => any;
+    getArguments: (event: any) => any;
+    getLeafDataItems: () => any;
+}
+/**
+ * @hidden
+ */
+export interface GridData {
+    currentData: Array<DataItemWrapper>;
+    _columns: ExtendedColumnProps[];
+    _columnsMap: number[][];
+    _header: any | null;
+    _footer: any | null;
+    _element: any | null;
+    forceUpdateTimeout: any;
+    groupPanelDivRef: any;
+    dropElementClueRef: any;
+    dragElementClueRef: any;
+    headerRef: any;
+    footerRef: any;
+    gridNavRef: any;
+    colGroupRef: any;
+    scrollContainerRef: any;
+    scrollTableRef: any;
+    scrollTableBodyRef: any;
+    isRtl: boolean;
+    context?: TableKeyboardNavigationContextType;
+    navigation?: TableKeyboardNavigationStateType;
+}
+/**
+ * @hidden
+ */
+export interface GridState {
+    initialHeight: String | null;
+    dragLogic: CommonDragLogic;
+    vs: VirtualScroll;
+    columnResize: ColumnResize;
+    _gridId: string;
+    v3: boolean;
+}
+/**
+ * @hidden
+ */
+export interface GridComputed {
+    [key: string]: any;
+    getCorrectHeight: any;
+    currentGroupable: boolean;
+    computedCollapsed: any[][];
+}
+/**
+ * @hidden
+ */
+export interface GridAll extends GridMethods, GridData, GridState, GridComputed, GridProps, Vue2type {
+}
+/**
+ * @hidden
+ */
+declare let GridVue2: ComponentOptions<Vue2type, DefaultData<GridData>, DefaultMethods<GridAll>, GridComputed, RecordPropsDefinition<GridProps>>;
+/**
+ * Represents the native Vue Grid component by Kendo UI.
+ *
+ * ```tsx-no-run
+ *   <div id="app">
+ *       <Grid
+ *           :data-items="products"
+ *           :columns="columns">
+ *        </Grid>
+ *   </div>
+ *   <script>
+ *       Vue.component('Grid', Grid);
+ *       new Vue({
+ *           el: '#app',
+ *           data: function () {
+ *               return {
+ *                  products: [
+ *                    { 'foo': 'A1', 'bar': 'B1' },
+ *                       { 'foo': 'A2', 'bar': 'B2' },
+ *                       { 'foo': 'A3', 'bar': 'B2' }
+ *                   ],
+ *                   columns: [
+ *                       { field: 'foo'},
+ *                       { field: 'bar'}
+ *                   ]
+ *               };
+ *           }
+ *       });
+ *   </script>
+ * ```
+ *
+ * ### props <span class='code'>[GridProps]({% slug api_grid_gridprops %})</span>
+ */
+declare const Grid: DefineComponent<GridProps, any, GridData, GridComputed, GridMethods, {}, {}, {}, string, GridProps, GridProps, {}>;
+export { Grid, GridVue2 };