Interface GridTools<DataType>

Type Parameters

Hierarchy

  • ReturnType<typeof useDataGridTools>
    • GridTools

Properties

__lastExpRowCache activeRow clearActiveRow clearExpandRowHeightCache closeExpandedRows columnDimensions columnOrder expandRowHeightCache expandedRowKeys getColumnWidth getExpandRowHeightFromCache isColumnGroupingEnabled isColumnIsDraggable isColumnIsResizable isColumnResizing isDarkModeEnabled isDynamicRowExpandHeightEnabled isFilterFnIsActive isFilterMenuVisible isFullScreenModeEnabled isHeaderIsActive isHeaderMenuActive isRightClickIsActive isRowActive isRowExpanded isRowSelected isVirtualizationIsEnabled onRowClick pinnedColumns selectedRows updateActiveHeader updateActiveRow updateColumnGrouping updateColumnOrder updateColumnResizingStatus updateColumnVisibility updateColumnWidth updateColumnWidthMultiple updateDarkMode updateExpandRowHeightCache updateFilterMenuVisibility updateFullScreenMode updatePinnedColumns updateRowExpansion updateSelectedRows updateSelectedRowsMultiple visibleColumns

Methods

getColumnByKey

Properties

__lastExpRowCache

__lastExpRowCache: MutableRefObject<null | {
    index: number;
    isOpen: boolean;
}>

activeRow

activeRow: undefined | string

clearActiveRow

clearActiveRow: (() => void)

Type declaration

    • (): void

    • Returns void

clearExpandRowHeightCache

clearExpandRowHeightCache: (() => void)

Type declaration

    • (): void

    • Returns void

closeExpandedRows

closeExpandedRows: (() => void)

Type declaration

    • (): void

    • Returns void

columnDimensions

columnDimensions: Record<string, number>

columnOrder

columnOrder: KeyLiteralType<DataType>[]

expandRowHeightCache

expandRowHeightCache: Record<number, undefined | number>

expandedRowKeys

expandedRowKeys: Set<number>

getColumnWidth

getColumnWidth: ((colKey: string) => number)

Type declaration

    • (colKey: string): number

    • Parameters

      • colKey: string

      Returns number

getExpandRowHeightFromCache

getExpandRowHeightFromCache: ((index: number) => undefined | number)

Type declaration

    • (index: number): undefined | number

    • Parameters

      • index: number

      Returns undefined | number

isColumnGroupingEnabled

isColumnGroupingEnabled: boolean

isColumnIsDraggable

isColumnIsDraggable: ((columnKey: string) => undefined | boolean)

Type declaration

    • (columnKey: string): undefined | boolean

    • Parameters

      • columnKey: string

      Returns undefined | boolean

isColumnIsResizable

isColumnIsResizable: ((columnKey: string) => undefined | boolean)

Type declaration

    • (columnKey: string): undefined | boolean

    • Parameters

      • columnKey: string

      Returns undefined | boolean

isColumnResizing

isColumnResizing: boolean

isDarkModeEnabled

isDarkModeEnabled: boolean

isDynamicRowExpandHeightEnabled

isDynamicRowExpandHeightEnabled: boolean

isFilterFnIsActive

isFilterFnIsActive: ((columnKey: string) => undefined | boolean)

Type declaration

    • (columnKey: string): undefined | boolean

    • Parameters

      • columnKey: string

      Returns undefined | boolean

isFilterMenuVisible

isFilterMenuVisible: boolean

isFullScreenModeEnabled

isFullScreenModeEnabled: boolean

isHeaderIsActive

isHeaderIsActive: ((key: string) => boolean)

Type declaration

    • (key: string): boolean

    • Parameters

      • key: string

      Returns boolean

isHeaderMenuActive

isHeaderMenuActive: boolean

isRightClickIsActive

isRightClickIsActive: undefined | boolean

isRowActive

isRowActive: ((uniqueRowKey: string) => boolean)

Type declaration

    • (uniqueRowKey: string): boolean

    • Parameters

      • uniqueRowKey: string

      Returns boolean

isRowExpanded

isRowExpanded: ((uniqueRowKey: number) => boolean)

Type declaration

    • (uniqueRowKey: number): boolean

    • Parameters

      • uniqueRowKey: number

      Returns boolean

isRowSelected

isRowSelected: ((uniqueRowKey: string) => boolean)

Type declaration

    • (uniqueRowKey: string): boolean

    • Parameters

      • uniqueRowKey: string

      Returns boolean

isVirtualizationIsEnabled

isVirtualizationIsEnabled: boolean

onRowClick

onRowClick: ((e: MouseEvent<HTMLDivElement, MouseEvent>, cellData: DataType) => void)

Type declaration

    • (e: MouseEvent<HTMLDivElement, MouseEvent>, cellData: DataType): void

    • Parameters

      • e: MouseEvent<HTMLDivElement, MouseEvent>
      • cellData: DataType

      Returns void

pinnedColumns

pinnedColumns: {
    left: KeyLiteralType<DataType>[];
    right: KeyLiteralType<DataType>[];
}

Type declaration

selectedRows

selectedRows: Set<DataGridRowKeyDefinition>

updateActiveHeader

updateActiveHeader: ((key: undefined | string) => void)

Type declaration

    • (key: undefined | string): void

    • Parameters

      • key: undefined | string

      Returns void

updateActiveRow

updateActiveRow: ((uniqueRowKey: string) => void)

Type declaration

    • (uniqueRowKey: string): void

    • Parameters

      • uniqueRowKey: string

      Returns void

updateColumnGrouping

updateColumnGrouping: (() => void)

Type declaration

    • (): void

    • Returns void

updateColumnOrder

updateColumnOrder: ((collection: KeyLiteralType<DataType>[]) => void)

Type declaration

updateColumnResizingStatus

updateColumnResizingStatus: ((val: boolean) => void)

Type declaration

    • (val: boolean): void

    • Parameters

      • val: boolean

      Returns void

updateColumnVisibility

updateColumnVisibility: ((key: string) => Set<KeyLiteralType<DataType>>)

Type declaration

updateColumnWidth

updateColumnWidth: ((key: string, newWidth: number) => void)

Type declaration

    • (key: string, newWidth: number): void

    • Parameters

      • key: string
      • newWidth: number

      Returns void

updateColumnWidthMultiple

updateColumnWidthMultiple: ((collection: Record<string, number>) => void)

Type declaration

    • (collection: Record<string, number>): void

    • Parameters

      • collection: Record<string, number>

      Returns void

updateDarkMode

updateDarkMode: (() => void)

Type declaration

    • (): void

    • Returns void

updateExpandRowHeightCache

updateExpandRowHeightCache: ((index: number, height: number, forceUpdate?: boolean) => void)

Type declaration

    • (index: number, height: number, forceUpdate?: boolean): void

    • Parameters

      • index: number
      • height: number
      • forceUpdate: boolean = false

      Returns void

updateFilterMenuVisibility

updateFilterMenuVisibility: (() => void)

Type declaration

    • (): void

    • Returns void

updateFullScreenMode

updateFullScreenMode: (() => void)

Type declaration

    • (): void

    • Returns void

updatePinnedColumns

updatePinnedColumns: ((colKey: string, position: "left" | "right") => void)

Type declaration

    • (colKey: string, position: "left" | "right"): void

    • Parameters

      • colKey: string
      • position: "left" | "right"

      Returns void

updateRowExpansion

updateRowExpansion: ((index: number) => void)

Type declaration

    • (index: number): void

    • Parameters

      • index: number

      Returns void

updateSelectedRows

updateSelectedRows: ((value: DataGridRowKeyDefinition) => void)

Type declaration

updateSelectedRowsMultiple

updateSelectedRowsMultiple: ((collection: Set<DataGridRowKeyDefinition>) => void)

Type declaration

visibleColumns

visibleColumns: Set<KeyLiteralType<DataType>>

Methods

getColumnByKey

Settings

Member Visibility

Theme

Generated using TypeDoc