@progress/kendo-vue-grid
Version:
81 lines (80 loc) • 2.58 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 { PropType } from 'vue';
import { GridSelectionChangeEvent } from './interfaces/events';
import { GridColumnProps } from './interfaces/GridColumnProps';
import { GridProps } from './interfaces/GridProps';
/**
* Represents the Kendo UI for Vue Grid's StatusItem object.
*
* @hidden
*/
interface StatusItem {
/**
* The type of the status item.
* Could be `sum`, `min`, `max`, `average`, `count`, `isTrue`, `isFalse`, `earliest` or `latest`.
*/
type: string;
/**
* The calculated value of the status item.
*/
value: number | boolean | Date;
/**
* The formatted value of the status item.
*/
formattedValue: string;
}
/**
* Represents the props of the Kendo UI for Vue Grid's StatusBar component.
*
* @hidden
*/
interface StatusBarProps {
/**
* The collection of status items to display in the status bar.
*/
data: StatusItem[];
}
/**
* Represents the Kendo UI for Vue Grid's StatusBar component.
*
* @hidden
*/
declare const StatusBar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
data: {
type: PropType<StatusItem[]>;
default: () => any[];
};
}>, () => import("vue/jsx-runtime").JSX.Element, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
data: {
type: PropType<StatusItem[]>;
default: () => any[];
};
}>> & Readonly<{}>, {
data: StatusItem[];
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
/**
* @hidden
*/
declare const leafColumns: (columns: GridColumnProps[]) => GridColumnProps[];
/**
* Represents the arguments of the getStatusData function.
*
* @hidden
*/
type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 'select'> & {
dataItemKey: Required<GridProps>['dataItemKey'];
};
/**
* Calculates the status data.
*
* @param args StatusDataArgs
* @returns StatusItem[]
*/
declare const getStatusData: (args: StatusDataArgs) => StatusItem[];
export { getStatusData, type StatusItem, StatusBar, type StatusDataArgs, type StatusBarProps, leafColumns };