@3mo/moddable-data-grid
Version:
A moddable variant of @3mo/fetchable-data-grid
43 lines • 2.59 kB
TypeScript
import { type FetchableDataGridParametersType } from '@3mo/fetchable-data-grid';
import { equals } from '@a11d/equals';
import { type DataGridColumn, type DataGridSorting, type DataGridPagination, type DataGridColumnSticky } from '@3mo/data-grid';
import { type ModdableDataGrid } from './ModdableDataGrid.js';
import type * as CSS from 'csstype';
export declare class ModdableDataGridModeColumn<T> {
static fromColumn<T>(column: DataGridColumn<T>): ModdableDataGridModeColumn<T>;
dataSelector: KeyPath.Of<T>;
width?: CSS.DataType.TrackBreadth<(string & {}) | 0>;
hidden?: boolean;
sticky?: DataGridColumnSticky;
constructor(init?: Partial<ModdableDataGridModeColumn<T>>);
[equals](other: ModdableDataGridModeColumn<T>): boolean;
apply(column: DataGridColumn<T>): DataGridColumn<T, unknown>;
}
export declare class ModdableDataGridMode<TData, TDataFetcherParameters extends FetchableDataGridParametersType> {
/**
* Extracts the mode from the current point in time of the data grid
* @param dataGrid The data grid to extract the mode from
* @returns The extracted mode
*/
static fromDataGrid<TData, TParameters extends FetchableDataGridParametersType>(dataGrid: ModdableDataGrid<TData, TParameters, any>): ModdableDataGridMode<TData, TParameters>;
readonly id: string;
readonly name: string;
readonly parameters?: TDataFetcherParameters;
columns?: Array<ModdableDataGridModeColumn<TData>>;
sorting?: DataGridSorting<TData>;
pagination?: DataGridPagination;
archived: boolean;
constructor(init?: Partial<ModdableDataGridMode<TData, TDataFetcherParameters>>);
clone(): ModdableDataGridMode<TData, TDataFetcherParameters>;
with(mode: Partial<ModdableDataGridMode<TData, TDataFetcherParameters>>): this;
copy(name?: string): ModdableDataGridMode<TData, TDataFetcherParameters>;
[equals](other: ModdableDataGridMode<TData, TDataFetcherParameters>): boolean;
private get definedParameters();
save(dataGrid: ModdableDataGrid<TData, TDataFetcherParameters, any>): Promise<void>;
select(dataGrid: ModdableDataGrid<TData, TDataFetcherParameters, any>): Promise<void>;
archive(dataGrid: ModdableDataGrid<TData, TDataFetcherParameters, any>): Promise<void>;
unarchive(dataGrid: ModdableDataGrid<TData, TDataFetcherParameters, any>): Promise<void>;
delete(dataGrid: ModdableDataGrid<TData, TDataFetcherParameters, any>): Promise<void>;
apply(dataGrid: ModdableDataGrid<TData, TDataFetcherParameters, any>): void;
}
//# sourceMappingURL=ModdableDataGridMode.d.ts.map