@progress/kendo-vue-grid
Version:
266 lines (265 loc) • 14.4 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import { GridProps } from './interfaces/GridProps';
import { GridDataStateChangeEvent, GridDetailExpandChangeEvent, GridFilterChangeEvent, GridGroupChangeEvent, GridGroupExpandChangeEvent, GridPageChangeEvent, GridSearchChangeEvent, GridSortChangeEvent, GridSelectionChangeEvent, GridHeaderSelectionChangeEvent, GridRowPinChangeEvent } from './interfaces/events';
/** @hidden */
export type GridState = {
filter?: GridProps['filter'];
highlight?: GridProps['highlight'];
search?: GridProps['search'];
select?: GridProps['select'];
sort?: GridProps['sort'];
skip?: GridProps['skip'];
take?: GridProps['take'];
group?: GridProps['group'];
detailExpand?: GridProps['detailExpand'];
groupExpand?: GridProps['groupExpand'];
columnsState?: GridProps['columnsState'];
pinnedTopRows?: GridProps['pinnedTopRows'];
pinnedBottomRows?: GridProps['pinnedBottomRows'];
};
declare const GridStateProvider: import('vue').DefineComponent<{
id?: string;
autoProcessData?: boolean | import('./utils/dataProcessing').AutoProcessDataConfig;
dataItemKey?: string;
alternatePerGroup?: boolean;
columns?: import('.').GridColumnProps[];
dataItems?: any[] | import('@progress/kendo-data-query').DataResult;
cells?: import('.').GridCellsSettings;
rows?: import('./interfaces/GridRowsSettings').GridRowsSettings;
sortable?: import('.').GridSortSettings;
onSortchange?: (event: GridSortChangeEvent) => void;
defaultSort?: import('@progress/kendo-data-query').SortDescriptor[];
sort?: import('@progress/kendo-data-query').SortDescriptor[];
pinnable?: boolean;
pinnedTopRows?: any[];
pinnedBottomRows?: any[];
defaultPinnedTopRows?: any[];
defaultPinnedBottomRows?: any[];
onRowpinchange?: (event: GridRowPinChangeEvent) => void;
filterable?: boolean;
search?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
defaultSearch?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
searchFields?: (string | import('@progress/kendo-vue-data-tools').SearchField)[];
onSearchchange?: (event: GridSearchChangeEvent) => void;
defaultFilter?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
filter?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
filterOperators?: import('./interfaces/GridFilterOperators').GridFilterOperators;
onFilterchange?: (event: GridFilterChangeEvent) => void;
columnsState?: import('.').GridColumnState[];
defaultColumnsState?: import('.').GridColumnState[];
columnMenu?: any;
columnMenuIcon?: import('@progress/kendo-vue-common').SVGIcon;
columnMenuAnimate?: boolean | import('@progress/kendo-vue-popup').PopupAnimation;
groupExpand?: import('@progress/kendo-vue-data-tools').GroupExpandDescriptor[];
defaultGroupExpand?: import('@progress/kendo-vue-data-tools').GroupExpandDescriptor[];
onGroupexpandchange?: (event: GridGroupExpandChangeEvent) => void;
detailExpand?: import('@progress/kendo-vue-data-tools').DetailExpandDescriptor;
defaultDetailExpand?: import('@progress/kendo-vue-data-tools').DetailExpandDescriptor;
onDetailexpandchange?: (event: GridDetailExpandChangeEvent) => void;
group?: import('@progress/kendo-data-query').GroupDescriptor[];
defaultGroup?: import('@progress/kendo-data-query').GroupDescriptor[];
onGroupchange?: (event: GridGroupChangeEvent) => void;
pageable?: any;
pageSize?: number;
take?: number;
defaultTake?: number;
onPagechange?: (event: GridPageChangeEvent) => void;
total?: number;
skip?: number;
defaultSkip?: number;
onExpandchange?: (event: import('./interfaces/events').GridExpandChangeEvent) => void;
fixedScroll?: boolean;
expandField?: string;
selectedField?: string;
onSelectionchange?: (event: GridSelectionChangeEvent) => void;
highlight?: {
[id: string]: boolean | {
[id: string]: boolean;
};
};
defaultSelect?: import('@progress/kendo-vue-data-tools').SelectDescriptor;
select?: import('@progress/kendo-vue-data-tools').SelectDescriptor;
selectable?: boolean | import('./interfaces/GridSelectableSettings').GridSelectableSettings;
onHeaderselectionchange?: (event: GridHeaderSelectionChangeEvent) => void;
onRowclick?: (event: import('./interfaces/events').GridRowClickEvent) => void;
onRowdblclick?: (event: import('./interfaces/events').GridRowClickEvent) => void;
onCellclick?: (event: any) => void;
onScroll?: (event: any) => void;
onEdit?: (event: import('./interfaces/events').GridEditEvent) => void;
onRemove?: (event: import('./interfaces/events').GridRemoveEvent) => void;
onSave?: (event: import('./interfaces/events').GridSaveEvent) => void;
onCancel?: (event: import('./interfaces/events').GridCancelEvent) => void;
onItemchange?: (event: import('./interfaces/events').GridItemChangeEvent) => void;
editField?: string;
rowSpannable?: boolean | import('./interfaces/GridRowSpannableSettings').GridRowSpannableSettings;
rowClass?: Function;
scrollable?: string;
size?: string;
dir?: string;
rowHeight?: number;
detailRowHeight?: number;
detail?: any;
expandColumn?: import('.').GridColumnProps;
style?: any;
onDatastatechange?: (event: GridDataStateChangeEvent) => void;
resizable?: boolean;
reorderable?: boolean;
groupable?: boolean | import('.').GridGroupableSettings;
onColumnresize?: (event: import('./interfaces/events').GridColumnResizeEvent) => void;
onColumnreorder?: (event: import('./interfaces/events').GridColumnReorderEvent) => void;
rowRender?: string | boolean | ((h: any, defaultRendering: any, defaultSlots: any, props: any, listeners: any) => any);
cellRender?: string | boolean | ((h: any, defaultRendering: any, props: import('.').GridCellProps, listeners: any) => any);
filterCellRender?: any;
headerCellRender?: any;
showLoader?: boolean;
loader?: string | Object;
lockGroups?: boolean;
pager?: string | boolean | Object;
columnVirtualization?: boolean;
contextMenu?: boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions);
onContextmenu?: (event: import('./interfaces/events').GridContextMenuEvent) => void;
onContextmenuitemclick?: (event: import('./interfaces/events').GridContextMenuItemClickEvent) => void;
clipboard?: boolean | import('@progress/kendo-vue-data-tools').ClipboardSettings;
onClipboard?: (event: import('@progress/kendo-vue-data-tools').GridClipboardEvent) => void;
navigatable?: boolean;
topCacheCount?: number;
totalGroupedHeight?: number;
allGroupedItems?: import('@progress/kendo-data-query').DataResult;
collapsedGroups?: any[][];
uniqueField?: string;
onNavigationaction?: (event: import('./interfaces/events').GridNavigationActionEvent) => void;
onKeydown?: (event: import('./interfaces/events').GridKeyDownEvent) => void;
csv?: boolean | import('./interfaces/GridProps').GridCSVExportOptions;
onCsvexport?: (data: any[]) => any[];
}, void, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
id?: string;
autoProcessData?: boolean | import('./utils/dataProcessing').AutoProcessDataConfig;
dataItemKey?: string;
alternatePerGroup?: boolean;
columns?: import('.').GridColumnProps[];
dataItems?: any[] | import('@progress/kendo-data-query').DataResult;
cells?: import('.').GridCellsSettings;
rows?: import('./interfaces/GridRowsSettings').GridRowsSettings;
sortable?: import('.').GridSortSettings;
onSortchange?: (event: GridSortChangeEvent) => void;
defaultSort?: import('@progress/kendo-data-query').SortDescriptor[];
sort?: import('@progress/kendo-data-query').SortDescriptor[];
pinnable?: boolean;
pinnedTopRows?: any[];
pinnedBottomRows?: any[];
defaultPinnedTopRows?: any[];
defaultPinnedBottomRows?: any[];
onRowpinchange?: (event: GridRowPinChangeEvent) => void;
filterable?: boolean;
search?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
defaultSearch?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
searchFields?: (string | import('@progress/kendo-vue-data-tools').SearchField)[];
onSearchchange?: (event: GridSearchChangeEvent) => void;
defaultFilter?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
filter?: import('@progress/kendo-data-query').CompositeFilterDescriptor;
filterOperators?: import('./interfaces/GridFilterOperators').GridFilterOperators;
onFilterchange?: (event: GridFilterChangeEvent) => void;
columnsState?: import('.').GridColumnState[];
defaultColumnsState?: import('.').GridColumnState[];
columnMenu?: any;
columnMenuIcon?: import('@progress/kendo-vue-common').SVGIcon;
columnMenuAnimate?: boolean | import('@progress/kendo-vue-popup').PopupAnimation;
groupExpand?: import('@progress/kendo-vue-data-tools').GroupExpandDescriptor[];
defaultGroupExpand?: import('@progress/kendo-vue-data-tools').GroupExpandDescriptor[];
onGroupexpandchange?: (event: GridGroupExpandChangeEvent) => void;
detailExpand?: import('@progress/kendo-vue-data-tools').DetailExpandDescriptor;
defaultDetailExpand?: import('@progress/kendo-vue-data-tools').DetailExpandDescriptor;
onDetailexpandchange?: (event: GridDetailExpandChangeEvent) => void;
group?: import('@progress/kendo-data-query').GroupDescriptor[];
defaultGroup?: import('@progress/kendo-data-query').GroupDescriptor[];
onGroupchange?: (event: GridGroupChangeEvent) => void;
pageable?: any;
pageSize?: number;
take?: number;
defaultTake?: number;
onPagechange?: (event: GridPageChangeEvent) => void;
total?: number;
skip?: number;
defaultSkip?: number;
onExpandchange?: (event: import('./interfaces/events').GridExpandChangeEvent) => void;
fixedScroll?: boolean;
expandField?: string;
selectedField?: string;
onSelectionchange?: (event: GridSelectionChangeEvent) => void;
highlight?: {
[id: string]: boolean | {
[id: string]: boolean;
};
};
defaultSelect?: import('@progress/kendo-vue-data-tools').SelectDescriptor;
select?: import('@progress/kendo-vue-data-tools').SelectDescriptor;
selectable?: boolean | import('./interfaces/GridSelectableSettings').GridSelectableSettings;
onHeaderselectionchange?: (event: GridHeaderSelectionChangeEvent) => void;
onRowclick?: (event: import('./interfaces/events').GridRowClickEvent) => void;
onRowdblclick?: (event: import('./interfaces/events').GridRowClickEvent) => void;
onCellclick?: (event: any) => void;
onScroll?: (event: any) => void;
onEdit?: (event: import('./interfaces/events').GridEditEvent) => void;
onRemove?: (event: import('./interfaces/events').GridRemoveEvent) => void;
onSave?: (event: import('./interfaces/events').GridSaveEvent) => void;
onCancel?: (event: import('./interfaces/events').GridCancelEvent) => void;
onItemchange?: (event: import('./interfaces/events').GridItemChangeEvent) => void;
editField?: string;
rowSpannable?: boolean | import('./interfaces/GridRowSpannableSettings').GridRowSpannableSettings;
rowClass?: Function;
scrollable?: string;
size?: string;
dir?: string;
rowHeight?: number;
detailRowHeight?: number;
detail?: any;
expandColumn?: import('.').GridColumnProps;
style?: any;
onDatastatechange?: (event: GridDataStateChangeEvent) => void;
resizable?: boolean;
reorderable?: boolean;
groupable?: boolean | import('.').GridGroupableSettings;
onColumnresize?: (event: import('./interfaces/events').GridColumnResizeEvent) => void;
onColumnreorder?: (event: import('./interfaces/events').GridColumnReorderEvent) => void;
rowRender?: string | boolean | ((h: any, defaultRendering: any, defaultSlots: any, props: any, listeners: any) => any);
cellRender?: string | boolean | ((h: any, defaultRendering: any, props: import('.').GridCellProps, listeners: any) => any);
filterCellRender?: any;
headerCellRender?: any;
showLoader?: boolean;
loader?: string | Object;
lockGroups?: boolean;
pager?: string | boolean | Object;
columnVirtualization?: boolean;
contextMenu?: boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions);
onContextmenu?: (event: import('./interfaces/events').GridContextMenuEvent) => void;
onContextmenuitemclick?: (event: import('./interfaces/events').GridContextMenuItemClickEvent) => void;
clipboard?: boolean | import('@progress/kendo-vue-data-tools').ClipboardSettings;
onClipboard?: (event: import('@progress/kendo-vue-data-tools').GridClipboardEvent) => void;
navigatable?: boolean;
topCacheCount?: number;
totalGroupedHeight?: number;
allGroupedItems?: import('@progress/kendo-data-query').DataResult;
collapsedGroups?: any[][];
uniqueField?: string;
onNavigationaction?: (event: import('./interfaces/events').GridNavigationActionEvent) => void;
onKeydown?: (event: import('./interfaces/events').GridKeyDownEvent) => void;
csv?: boolean | import('./interfaces/GridProps').GridCSVExportOptions;
onCsvexport?: (data: any[]) => any[];
}> & Readonly<{}>, {
size: string;
scrollable: string;
navigatable: boolean;
columnMenuAnimate: boolean;
topCacheCount: number;
collapsedGroups: any[][];
columnsState: import('.').GridColumnState[];
defaultColumnsState: import('.').GridColumnState[];
showLoader: boolean;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export { GridStateProvider };