@talxis/base-controls 1.2509.6 → 1.2512.1

package/dist/components/Grid/grid/GridModel.d.ts

@@ -0,0 +1,110 @@
+/// <reference types="@types/powerapps-component-framework" />
+import { AggregationFunction, Filtering, IColumn, ICustomColumnControl, ICustomColumnFormatting, IDataset, IRecord, TotalRow } from "@talxis/client-libraries";
+import { ITheme } from "@talxis/react-components";
+import { gridTranslations } from "../translations";
+import { ITranslation } from "../../../hooks";
+import { IBinding } from "../../NestedControlRenderer/interfaces";
+import { IFluentDesignState } from "../../../utils";
+import { IGrid, IGridParameters } from "../interfaces";
+interface IGridDependencies {
+    labels: Required<ITranslation<typeof gridTranslations>>;
+    onGetProps: () => IGrid;
+    theme?: ITheme;
+}
+interface IPCFContext extends Omit<ComponentFramework.Context<any, any>, 'fluentDesignLanguage'> {
+    fluentDesignLanguage?: IFluentDesignState;
+}
+export interface IGridColumn extends IColumn {
+    isRequired: boolean;
+    isEditable: boolean;
+    isFilterable: boolean;
+    isSorted: boolean;
+    isFiltered: boolean;
+    canBeAggregated: boolean;
+    canBeGrouped: boolean;
+    isSortedDescending: boolean;
+    isResizable: boolean;
+    alignment: IColumn['alignment'];
+}
+export declare class GridModel {
+    readonly oddRowCellTheme: ITheme;
+    readonly evenRowCellTheme: ITheme;
+    private _getProps;
+    private _labels;
+    private _theme;
+    private _sorting;
+    private _totalRow;
+    private _grouping;
+    private _filtering;
+    private _nestedProviderPagingLimitNotificationId;
+    private _cachedGridColumnsMap;
+    constructor({ onGetProps, labels, theme }: IGridDependencies);
+    getDataset(): IDataset;
+    getPcfContext(): IPCFContext;
+    getState(): ComponentFramework.Dictionary | undefined;
+    getParameters(): IGridParameters;
+    getLabels(): Required<ITranslation<typeof gridTranslations>>;
+    isZebraEnabled(): boolean;
+    isNavigationEnabled(): boolean;
+    isAutoSaveEnabled(): boolean;
+    isGroupedColumnsPinnedEnabled(): boolean;
+    getInlineRibbonButtonIds(): string | null;
+    isEditingEnabled(): boolean;
+    getGroupType(): 'nested' | 'flat';
+    optionSetColorsEnabled(): boolean;
+    getDefaultExpandedGroupLevel(): number;
+    getLicenseKey(): string | null;
+    getDefaultRowHeight(): number;
+    getSelectionType(): 'none' | 'single' | 'multiple';
+    getControl(column: IColumn, record: IRecord, editing: boolean): Required<ICustomColumnControl>;
+    getBindings(record: IRecord, column: IColumn, control: ICustomColumnControl): {
+        [name: string]: IBinding;
+    };
+    getFieldBindingParameters(record: IRecord, column: IColumn, editing: boolean): any;
+    isColumnExpandable(record: IRecord, column: IColumn): boolean;
+    getFieldFormatting(record: IRecord, columnName: string): Required<ICustomColumnFormatting>;
+    getDefaultCellTheme(record: IRecord): ITheme;
+    getGridColumns(): IGridColumn[];
+    getColumnByName(columnName: string): IColumn;
+    getGridColumnByName(columnName: string, force?: boolean): IGridColumn;
+    getRecordValue(record: IRecord, column: IColumn | string): {
+        value: any;
+        aggregatedValue: any;
+    };
+    getRecordFormattedValue(record: IRecord, column: IColumn | string): {
+        value: any;
+        aggregatedValue: any;
+    };
+    getControlValue(record: IRecord, column: IColumn | string): any;
+    isRecordSelectionDisabled(record: IRecord): boolean;
+    isColumnEditable(columnName: string, record?: IRecord): boolean;
+    addAggregation(columnName: string, aggregationFunction: AggregationFunction): void;
+    removeAggregation(alias: string): void;
+    toggleColumnGroup(columnName: string): void;
+    getColumnFilter(columnName: string): import("@talxis/client-libraries").ColumnFilter;
+    removeColumnFilter(columnName: string, saveToDataset?: boolean): void;
+    sortColumn(columnName: string, descending?: boolean): void;
+    clearColumnSorting(columnName: string): void;
+    getTotalRow(): TotalRow;
+    getFiltering(): Filtering;
+    isSelectionModifierKeyPressed(): boolean;
+    getColumnSortingLabel(columnName: string, descending?: boolean): string;
+    destroy(): void;
+    private _getInternalDataProvider;
+    private _setAggregationDecorator;
+    private _getRecordValue;
+    private _isRecordFieldEditable;
+    private _isColumnRequired;
+    private _isColumnSortable;
+    private _isColumnFilterable;
+    private _isColumnGroupable;
+    private _isColumnEditable;
+    private _canColumnBeAggregated;
+    private _registerEventListeners;
+    private _showNestedProviderPagingLimitNotification;
+    private _autoSaveRecord;
+    private _refreshTotalRowOnAutoSave;
+    private _setGroupingInterceptor;
+    private get _dataset();
+}
+export {};