Function createApi

  • Parameters

    Returns {
        addGroupBy: ((columnIdentifier: string) => void);
        applyColumnSettings: ((settings: ColumnSettings[]) => void);
        applySettings: ((settings: SettingsData) => void);
        applySettingsByName: ((name: string) => void);
        areAllRowsSelected: (() => boolean);
        areRowsSelected: ((rows?: unknown[], levelDepth?: number) => boolean);
        autoFitColumns: ((columns?: ColumnOptions[], includeHeader?: boolean) => void);
        beginEdit: ((cell: CellInfo) => void);
        buildFilterString: ((f: Filter) => string);
        clearAllFilterValues: (() => void);
        clearAllSettings: (() => void);
        clearAllSorts: (() => void);
        clearContext: (() => void);
        clearFilterValue: ((columnIdentifier: string) => void);
        clearGroupBy: (() => void);
        clearSelection: (() => void);
        clearSort: ((columnIdentifier: string) => void);
        collapseAll: (() => void);
        collapseOneLevel: (() => void);
        collapseRow: ((rowIdentifier: string) => void);
        copyAll: ((cell: CellSelelection) => void);
        copyCell: ((cell: CellSelelection) => void);
        copyColumn: ((cell: CellSelelection) => void);
        copyRow: ((cell: CellSelelection) => void);
        copySelectedCells: ((cell: CellSelelection) => void);
        copySelectedRows: ((cell: CellSelelection) => void);
        deselectCell: ((cellSelection: CellSelelection, e?: MouseEvent) => void);
        deselectRow: ((cell: CellSelelection) => void);
        dispatchFilterPageSortChanged: (() => void);
        endEdit: (() => void);
        expandAll: (() => void);
        expandOneLevel: (() => void);
        expandRow: ((rowIdentifier: string) => void);
        focusCell: ((cellSelection: CellSelelection, e?: MouseEvent) => void);
        getAllFilterValues: (() => Map<string, unknown>);
        getCellFromHtmlElement: ((elem: HTMLElement) => {
            columnIdentifier: string;
            rowIdentifier: string;
        });
        getCellInDirection: ((cell: CellSelelection, direction: Direction) => null | CellSelelection);
        getCurrentSettings: (() => ColumnSettings[]);
        getDistinctFilterValues: ((column: ColumnOptions) => unknown[]);
        getFilterDisplayValue: ((value: unknown, col?: ColumnOptions) => string);
        getFilterValue: ((columnIdentifier: string) => unknown);
        getFilteredDataProvider: (() => unknown[]);
        getFlatColumns: (() => ColumnOptions[]);
        getFlatColumnsAtAllLevels: (() => ColumnOptions[]);
        getFocusCell: (() => undefined | CellSelelection);
        getGridBox: ((exludeToolbar?: boolean) => DOMRect);
        getGroupByFields: (() => {
            name: string;
            value: string;
        }[]);
        getGroupChildren: ((item: unknown, level?: GridLevelOptions) => unknown[]);
        getGroupedDataProvider: ((rawData: unknown[], groupingFields: string[]) => {
            groupedData: unknown[];
            parentMap: {
                [key: string]: string;
            };
        });
        getRowChildren: ((row: unknown, level?: number) => unknown[]);
        getSelectedCells: (() => CellSelelection[]);
        getSelectedRows: (() => unknown[]);
        getSettingsByName: ((name: string) => undefined | SettingsData);
        getSort: ((col: string, level?: number) => any);
        getSorts: (() => Map<number, Map<string, SortInfo>>);
        gotoPosition: ((scrollLeft: number, scrollTop: number) => void);
        gotoRowColumn: ((cellSelection: CellSelelection) => void);
        groupBy: ((columnIdentifiers: string[]) => void);
        handleCellClick: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellDoubleClick: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellDragEnd: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellDragOver: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellDragStart: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellDrop: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellMouseDown: ((cell: CellSelelection, triggerEvent: MouseEvent) => void);
        handleCellMouseOut: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellMouseOver: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellMouseUp: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void);
        handleCellRightClick: ((cell: CellSelelection, e: MouseEvent) => void);
        handleKeyboardEvent: ((event: KeyboardEvent) => void);
        hasBehavior: ((behavior: Behaviors) => undefined | boolean);
        hasChange: ((rowIdentifier: string, columnIdentifier: string) => undefined | EditInfo);
        hasGroupingColumn: (() => boolean);
        highlightCell: ((cellSelection: CellSelelection, e?: MouseEvent) => void);
        keyStrokeValid: ((event: KeyboardEvent, col?: ColumnOptions) => boolean);
        loadSettings: (() => SettingsData[]);
        processCellClick: ((cell: CellInfo, triggerEvent?: MouseEvent) => void);
        processKeyBoardEvent: ((cell: CellInfo, event: KeyboardEvent) => void);
        propsUpdated: (() => void);
        rebuild: (() => void);
        removeGroupBy: ((columnIdentifiers: string) => void);
        repaint: (() => void);
        resetView: (() => void);
        resumeMouseEvents: (() => void);
        saveSettings: ((settings: SettingsData) => void);
        selectAll: (() => void);
        selectCell: ((cell: CellSelelection, e?: MouseEvent) => void);
        selectRow: ((cell: CellSelelection) => void);
        setColumnWidth: ((columnIdentifier: string, width: number) => void);
        setFilterValue: ((columnIdentifier: string, value: unknown) => void);
        setGlobalFilter: ((value: string) => void);
        setGlobalFilterTree: ((value: Filter) => void);
        setLockMode: ((columnIdentifier: string, lockMode: null | LockMode) => void);
        setQuickFindValue: ((value: string, next: boolean) => void);
        setSelectedRows: ((rowIds: string[]) => void);
        setSort: ((sortInfo: {
            isAscending: boolean;
            sortColumn: string;
        }) => void);
        setSorts: ((sorts: {
            isAscending: boolean;
            sortColumn: string;
        }[]) => void);
        shiftColumn: ((columnIdentifier?: string, nextToCell?: CellSelelection, dryRun?: boolean) => undefined | ColumnPositionInfo);
        shiftRow: ((rowIdentifier?: string, nextToRowIdentifier?: string, dryRun?: boolean, above?: boolean, dragValid?: ((from: string, to: string) => boolean)) => undefined | RowPositionInfo);
        showHideColumn: ((columnIdentifier: string, show: boolean) => void);
        showHideContextMenu: ((show?: boolean, cell?: CellSelelection, mouseEvent?: MouseEvent) => void);
        suspendMouseEvents: (() => void);
        toggleExpandCollapseColumnGroup: ((columnIdentifier: string, e: MouseEvent) => void);
        toggleExpandCollapseRow: ((rowIdentifier: string, e: MouseEvent) => void);
        toggleSelection: ((cell: CellSelelection) => void);
        toggleSort: ((columnIdentifier: string, clearOthers?: boolean, e?: MouseEvent) => void);
        unlockAllColumns: (() => void);
        addChange(row: RowPositionInfo, column: ColumnPositionInfo, value: unknown): void;
        canCollapse(): boolean;
        canExpand(): boolean;
        cancelEdit(): void;
        clearChanges(): void;
        exportToExcel(): void;
        exportToPdf(): void;
        getChanges(): EditInfo[];
        getContext(): undefined | GridContext;
        pageOperation(operation: "first" | "last" | "previous" | "next" | "pageSizeChanged", newPageSize?: number): void;
        removeChange(rowIdentifier: string, columnIdentifier: string): void;
        saveDefaultView(): void;
    }

    • addGroupBy: ((columnIdentifier: string) => void)
        • (columnIdentifier: string): void

        • Parameters

          • columnIdentifier: string

          Returns void

    • applyColumnSettings: ((settings: ColumnSettings[]) => void)
    • applySettings: ((settings: SettingsData) => void)
    • applySettingsByName: ((name: string) => void)
        • (name: string): void

        • Parameters

          • name: string

          Returns void

    • areAllRowsSelected: (() => boolean)
        • (): boolean

        • areAllRowsSelected returns true if all rows are selected, including the children of the rows recursively. Only applicable if the selectionMode is set to GridSelectionMode.SingleRow or GridSelectionMode.MultipleRows (default).

          Returns boolean

    • areRowsSelected: ((rows?: unknown[], levelDepth?: number) => boolean)
        • (rows?: unknown[], levelDepth?: number): boolean

        • areRowsSelected returns true if the specified rows are selected, including the children of the rows recursively. Only applicable if the selectionMode is set to GridSelectionMode.SingleRow or GridSelectionMode.MultipleRows (default).

          Parameters

          • Optional rows: unknown[]
          • Optional levelDepth: number

          Returns boolean

    • autoFitColumns: ((columns?: ColumnOptions[], includeHeader?: boolean) => void)
        • (columns?: ColumnOptions[], includeHeader?: boolean): void

        • autoFitColumns auto fits the specified columns. If no columns are specified, all columns are auto fitted.

          Parameters

          • Optional columns: ColumnOptions[]

            The columns to auto fit.

          • Optional includeHeader: boolean

            Whether to include the header text in the auto fit.

          Returns void

    • beginEdit: ((cell: CellInfo) => void)
        • (cell: CellInfo): void

        • Starts editing a cell. The editor will be created and the cell will be repainted.

          Parameters

          Returns void

    • buildFilterString: ((f: Filter) => string)
        • (f: Filter): string

        • Builds a filter string from the specified filter. Used by the filter builder to provide the user with contextual information about the filter.

          Returns

          The filter string

          Parameters

          Returns string

    • clearAllFilterValues: (() => void)
        • (): void

        • clearAllFilterValues clears all filter values.

          Returns void

    • clearAllSettings: (() => void)
        • (): void

        • Returns void

    • clearAllSorts: (() => void)
        • (): void

        • clearAllSorts clears all sorts.

          Returns void

    • clearContext: (() => void)
        • (): void

        • Returns void

    • clearFilterValue: ((columnIdentifier: string) => void)
        • (columnIdentifier: string): void

        • clearFilterValue clears the filter value for the specified column.

          Parameters

          • columnIdentifier: string

            The unique identifier of the column

          Returns void

    • clearGroupBy: (() => void)
        • (): void

        • Returns void

    • clearSelection: (() => void)
        • (): void

        • clearSelection clears the selection, regardless of the selection mode.

          Returns void

    • clearSort: ((columnIdentifier: string) => void)
        • (columnIdentifier: string): void

        • clearSort clears the sort for the specified column.

          Parameters

          • columnIdentifier: string

            The unique identifier of the column

          Returns void

    • collapseAll: (() => void)
        • (): void

        • Returns void

    • collapseOneLevel: (() => void)
        • (): void

        • Returns void

    • collapseRow: ((rowIdentifier: string) => void)
        • (rowIdentifier: string): void

        • CollapseRow collapses the specified row. Only applicable for hierarchical data.

          Parameters

          • rowIdentifier: string

            The row identifier of the row to expand or collapse.

          Returns void

    • copyAll: ((cell: CellSelelection) => void)
    • copyCell: ((cell: CellSelelection) => void)
    • copyColumn: ((cell: CellSelelection) => void)
        • (cell: CellSelelection): void

        • copyColumn copies the specified column to the clipboard.

          Parameters

          Returns void

    • copyRow: ((cell: CellSelelection) => void)
        • (cell: CellSelelection): void

        • copyRow copies the specified row to the clipboard. Iterates through the cols in the row, calls itemToLabel on each of them and return the resulting string in tab delimited format

          Parameters

          Returns void

    • copySelectedCells: ((cell: CellSelelection) => void)
    • copySelectedRows: ((cell: CellSelelection) => void)
    • deselectCell: ((cellSelection: CellSelelection, e?: MouseEvent) => void)
        • (cellSelection: CellSelelection, e?: MouseEvent): void

        • deselectCell deselects the specified cell. Only applicable if the selectionMode is set to GridSelectionMode.SingleCell or GridSelectionMode.MultipleCells.

          Parameters

          • cellSelection: CellSelelection
          • Optional e: MouseEvent

            The mouse event that triggered the deselection.

          Returns void

    • deselectRow: ((cell: CellSelelection) => void)
        • (cell: CellSelelection): void

        • deselectRow deselects the specified row. Only applicable if the selectionMode is set to GridSelectionMode.SingleRow or GridSelectionMode.MultipleRows (default).

          Parameters

          • cell: CellSelelection

            The cell from which we can use the rowIdentifier to deselect the row.

          Returns void

    • dispatchFilterPageSortChanged: (() => void)
        • (): void

        • dispatchFilterPageSortChanged dispatches the onFilterPageSortChanged event. This event is used to notify the user that the filter, page, or sort has changed. The event is dispatched when the user changes the filter, page, or sort. The event is also dispatched when the user clears the filter, page, or sort. The event is dispatched when the user changes the global filter.

          Returns void

    • endEdit: (() => void)
        • (): void

        • End the current edit session. The editor will be removed and the cell will be repainted.

          Returns void

    • expandAll: (() => void)
        • (): void

        • Returns void

    • expandOneLevel: (() => void)
        • (): void

        • Returns void

    • expandRow: ((rowIdentifier: string) => void)
        • (rowIdentifier: string): void

        • ExpandRow expands the specified row. Only applicable for hierarchical data.

          Parameters

          • rowIdentifier: string

            The row identifier of the row to expand or collapse.

          Returns void

    • focusCell: ((cellSelection: CellSelelection, e?: MouseEvent) => void)
        • (cellSelection: CellSelelection, e?: MouseEvent): void

        • focusCell focuses the specified cell. The cell is focused by adding a class to thpe cell. You can customize euxdt-dg-focus-cell css class to change the appearance of the focused cell. This will only work if enableFocusCellHighlight is set to true. The default value is false.

          Parameters

          • cellSelection: CellSelelection

            The cell to focus

          • Optional e: MouseEvent

            The mouse event that triggered the focus

          Returns void

    • getAllFilterValues: (() => Map<string, unknown>)
        • (): Map<string, unknown>

        • getAllFilterValues returns a map of all filter values. The key is the column identifier and the value is the filter value. The filter value is a string for TextInputFilter and SelectFilter, an object with start and end properties for DateRangeFilter, NumberRangeFilter an array of strings for MultiSelectFilter, and a boolean for TriStateCheckboxFilter.

          Returns

          A map of all filter values

          Returns Map<string, unknown>

    • getCellFromHtmlElement: ((elem: HTMLElement) => {
          columnIdentifier: string;
          rowIdentifier: string;
      })
        • (elem: HTMLElement): {
              columnIdentifier: string;
              rowIdentifier: string;
          }

        • Parameters

          • elem: HTMLElement

          Returns {
              columnIdentifier: string;
              rowIdentifier: string;
          }

          • columnIdentifier: string
          • rowIdentifier: string
    • getCellInDirection: ((cell: CellSelelection, direction: Direction) => null | CellSelelection)
    • getCurrentSettings: (() => ColumnSettings[])
    • getDistinctFilterValues: ((column: ColumnOptions) => unknown[])
        • (column: ColumnOptions): unknown[]

        • getDistinctFilterValues returns the distinct values for the specified column. If you have specified a filterComboBoxDataProvider, it returns the values returned by the filterComboBoxDataProvider. Otherwise, it returns the distinct values for the column.

          Parameters

          Returns unknown[]

    • getFilterDisplayValue: ((value: unknown, col?: ColumnOptions) => string)
        • (value: unknown, col?: ColumnOptions): string

        • getFilterDisplayValue returns the display value for the specified filter value. It uses the columns built in formatting to format the value.

          Returns

          The display value for the filter value

          Parameters

          • value: unknown

            The filter value. The filter value is a string for TextInputFilter and SelectFilter, an object with start and end properties for DateRangeFilter, NumberRangeFilter an array of strings for MultiSelectFilter, and a boolean for TriStateCheckboxFilter.

          • Optional col: ColumnOptions

            The column

          Returns string

    • getFilterValue: ((columnIdentifier: string) => unknown)
        • (columnIdentifier: string): unknown

        • getFilterValue returns the filter value for the specified column. If the column is not filtered, it returns undefined. If the column is filtered, it returns the filter value. The filter value is a string for TextInputFilter and SelectFilter, an object with start and end properties for DateRangeFilter, NumberRangeFilter an array of strings for MultiSelectFilter, and a boolean for TriStateCheckboxFilter.

          Parameters

          • columnIdentifier: string

            The unique identifier of the column

          Returns unknown

    • getFilteredDataProvider: (() => unknown[])
        • (): unknown[]

        • Returns unknown[]

    • getFlatColumns: (() => ColumnOptions[])
        • (): ColumnOptions[]

        • getFlatColumns returns a flat array of all columns. The columns are returned in the order they are displayed in the grid. The children of a column are returned after the column.

          Returns

          A flat array of all columns

          Returns ColumnOptions[]

    • getFlatColumnsAtAllLevels: (() => ColumnOptions[])
        • (): ColumnOptions[]

        • getFlatColumnsAtAllLevels returns a flat array of all columns. The columns are returned in the order they are displayed in the grid. The children of a column are returned after the column. The columns are returned at all levels, including inner level columns for nested grids.

          Returns

          A flat array of all columns

          Returns ColumnOptions[]

    • getFocusCell: (() => undefined | CellSelelection)
        • (): undefined | CellSelelection

        • getFocusCell returns the cell that has focus. Only applicable if the enableFocusCell is set to true.

          Returns undefined | CellSelelection

    • getGridBox: ((exludeToolbar?: boolean) => DOMRect)
        • (exludeToolbar?: boolean): DOMRect

        • Parameters

          • exludeToolbar: boolean = false

          Returns DOMRect

    • getGroupByFields: (() => {
          name: string;
          value: string;
      }[])
        • (): {
              name: string;
              value: string;
          }[]

        • Returns {
              name: string;
              value: string;
          }[]

    • getGroupChildren: ((item: unknown, level?: GridLevelOptions) => unknown[])
    • getGroupedDataProvider: ((rawData: unknown[], groupingFields: string[]) => {
          groupedData: unknown[];
          parentMap: {
              [key: string]: string;
          };
      })
        • (rawData: unknown[], groupingFields: string[]): {
              groupedData: unknown[];
              parentMap: {
                  [key: string]: string;
              };
          }

        • Parameters

          • rawData: unknown[]
          • groupingFields: string[]

          Returns {
              groupedData: unknown[];
              parentMap: {
                  [key: string]: string;
              };
          }

          • groupedData: unknown[]
          • parentMap: {
                [key: string]: string;
            }
            • [key: string]: string
    • getRowChildren: ((row: unknown, level?: number) => unknown[])
        • (row: unknown, level?: number): unknown[]

        • getRowChildren returns the children of the specified row. Only applicable for hierarchical data.

          Parameters

          • row: unknown
          • Optional level: number

          Returns unknown[]

    • getSelectedCells: (() => CellSelelection[])
        • (): CellSelelection[]

        • getSelectedCells returns the selected cells. Only applicable if the selectionMode is set to GridSelectionMode.SingleCell or GridSelectionMode.MultipleCells.

          Returns CellSelelection[]

    • getSelectedRows: (() => unknown[])
        • (): unknown[]

        • getSelectedRows returns the selected rows. Only applicable if the selectionMode is set to GridSelectionMode.SingleRow or GridSelectionMode.MultipleRows (default).

          Returns unknown[]

    • getSettingsByName: ((name: string) => undefined | SettingsData)
    • getSort: ((col: string, level?: number) => any)
        • (col: string, level?: number): any

        • getSort returns the sort for the specified column. The returned value is a Sort Info object. The Sort Info contains the column identifier, the sort direction, additional information as specified in the column's definition.

          Parameters

          • col: string
          • level: number = 1

          Returns any

    • getSorts: (() => Map<number, Map<string, SortInfo>>)
        • (): Map<number, Map<string, SortInfo>>

        • getSorts returns the sorts for the specified level. The returned value is a map of column identifiers and sort information. The Sort Info contains the column identifier, the sort direction, additional information as specified in the column's definition.

          Returns Map<number, Map<string, SortInfo>>

    • gotoPosition: ((scrollLeft: number, scrollTop: number) => void)
        • (scrollLeft: number, scrollTop: number): void

        • Parameters

          • scrollLeft: number
          • scrollTop: number

          Returns void

    • gotoRowColumn: ((cellSelection: CellSelelection) => void)
    • groupBy: ((columnIdentifiers: string[]) => void)
        • (columnIdentifiers: string[]): void

        • Parameters

          • columnIdentifiers: string[]

          Returns void

    • handleCellClick: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellDoubleClick: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellDragEnd: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellDragOver: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellDragStart: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellDrop: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellMouseDown: ((cell: CellSelelection, triggerEvent: MouseEvent) => void)
    • handleCellMouseOut: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellMouseOver: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellMouseUp: ((cell: CellSelelection, triggerEvent?: MouseEvent) => void)
    • handleCellRightClick: ((cell: CellSelelection, e: MouseEvent) => void)
    • handleKeyboardEvent: ((event: KeyboardEvent) => void)
        • (event: KeyboardEvent): void

        • Parameters

          • event: KeyboardEvent

          Returns void

    • hasBehavior: ((behavior: Behaviors) => undefined | boolean)
        • (behavior: Behaviors): undefined | boolean

        • Parameters

          Returns undefined | boolean

    • hasChange: ((rowIdentifier: string, columnIdentifier: string) => undefined | EditInfo)
        • (rowIdentifier: string, columnIdentifier: string): undefined | EditInfo

        • Parameters

          • rowIdentifier: string
          • columnIdentifier: string

          Returns undefined | EditInfo

    • hasGroupingColumn: (() => boolean)
        • (): boolean

        • Returns boolean

    • highlightCell: ((cellSelection: CellSelelection, e?: MouseEvent) => void)
        • (cellSelection: CellSelelection, e?: MouseEvent): void

        • highlightCell highlights the specified cell. The cell is highlighted by adding a class to thpe cell. You can customize euxdt-dg-active-cell css class to change the appearance of the highlighted cell. This will only work if enableActiveCellHighlight is set to true. The default value is false.

          Parameters

          • cellSelection: CellSelelection

            The cell to highlight

          • Optional e: MouseEvent

            The mouse event that triggered the highlight

          Returns void

    • keyStrokeValid: ((event: KeyboardEvent, col?: ColumnOptions) => boolean)
    • loadSettings: (() => SettingsData[])
    • processCellClick: ((cell: CellInfo, triggerEvent?: MouseEvent) => void)
        • (cell: CellInfo, triggerEvent?: MouseEvent): void

        • Parameters

          • cell: CellInfo
          • Optional triggerEvent: MouseEvent

          Returns void

    • processKeyBoardEvent: ((cell: CellInfo, event: KeyboardEvent) => void)
        • (cell: CellInfo, event: KeyboardEvent): void

        • Support for key board interaction. If the body container is in edit mode, keyboard interaction that is handled is limited to the TAB and Enter keys, which will end the edit session and move on to the next cell or row on basis of which key has been selected.
          If we are in any of the filter control, the TAB and SHIFT TAB keys will move between the filter controls. Once you focus on a filter control, all keyboard interaction except TAB, SHIFT TAB and Arrow Keys is handled by the Filter Control in question. These are all Flex SDK controls, and you should refer to the the documentation of the SDK control for more information about its keyboard interaction. Arrow keys will move focus out of the filter control and highlight the next cell (for down arrow) or the header (for up arrow) on basis of what the displayOrder property of the grid specifies.
          We have a concept of an active cell, which is the cell that is currently active either via a click, or via a arrow key navigation gesture. You can style this color of the active cell via the euxdt-dg-focus-cell style. You can completely disable the active cell tracking by setting enableFocusCellHighlight to false.

          When the grid is not in edit mode, and focus is not on the filter but on a specific grid cell, the following keyboard interactions are available:

          • Keyboard.UP : Navigates to the cell and row above the currently focused cell.
          • Keyboard.DOWN : Navigates to the cell and row below the currently focused cell
          • Keyboard.LEFT : Navigates to the cell to the left the currently focused cell
          • Keyboard.RIGHT : Navigates to the cell to the right the currently focused cell
          • Keyboard.TAB : Relinquishes focus from the grid and moves on to the next focussable control in the display tree
          • Keyboard.PAGE_DOWN: Moves the scroll bar down by the height of the grid and highlights the newly visible first row
          • Keyboard.PAGE_UP: Moves the scroll bar up by the height of the grid and highlights the newly visible first row
          • Keyboard.HOME: Moves the scroll to the top (i.e.) the first record of the grid and highlights the newly visible first row
          • Keyboard.END: Moves the scroll to the end (i.e.) the last record of the grid and highlights the newly visible first row
          • Keyboard.SPACE: Performs the equivalent of a click on the active cell

          Method

          keyDownHandler

          Parameters

          Returns void

    • propsUpdated: (() => void)
        • (): void

        • propsUpdated is called when the props of the grid are updated. This is useful if the grid is not automatically rebuilding outside of these scenarios.

          Returns void

    • rebuild: (() => void)
        • (): void

        • Rebuild rebuilds the grid. The grid automatically rebuilds if the data provider or the size of the grid changes. This method is useful if the grid is not automatically rebuilding outside of these scenarios.

          Returns void

    • removeGroupBy: ((columnIdentifiers: string) => void)
        • (columnIdentifiers: string): void

        • Parameters

          • columnIdentifiers: string

          Returns void

    • repaint: (() => void)
        • (): void

        • Repaint repaints the grid. The grid automatically repaints on mouse events and keyboard events. This method is useful if the grid is not automatically repainting outside of these scenarios.

          Returns void

    • resetView: (() => void)
        • (): void

        • Returns void

    • resumeMouseEvents: (() => void)
        • (): void

        • Returns void

    • saveSettings: ((settings: SettingsData) => void)
    • selectAll: (() => void)
        • (): void

        • selectAll selects all rows or cells, depending on the selection mode.

          Returns void

    • selectCell: ((cell: CellSelelection, e?: MouseEvent) => void)
        • (cell: CellSelelection, e?: MouseEvent): void

        • selectCell selects the specified cell. Only applicable if the selectionMode is set to GridSelectionMode.SingleCell or GridSelectionMode.MultipleCells.

          Parameters

          • cell: CellSelelection

            The cell to select.

          • Optional e: MouseEvent

            The mouse event that triggered the selection.

          Returns void

    • selectRow: ((cell: CellSelelection) => void)
        • (cell: CellSelelection): void

        • selectRow selects the specified row. Only applicable if the selectionMode is set to GridSelectionMode.SingleRow or GridSelectionMode.MultipleRows (default).

          Parameters

          • cell: CellSelelection

            The cell from which we can use the rowIdentifier to select the row.

          Returns void

    • setColumnWidth: ((columnIdentifier: string, width: number) => void)
        • (columnIdentifier: string, width: number): void

        • Parameters

          • columnIdentifier: string
          • width: number

          Returns void

    • setFilterValue: ((columnIdentifier: string, value: unknown) => void)
        • (columnIdentifier: string, value: unknown): void

        • setFilterValue sets the filter value for the specified column.

          Parameters

          • columnIdentifier: string

            The unique identifier of the column

          • value: unknown

            The filter value. The filter value is a string for TextInputFilter and SelectFilter, an object with start and end properties for DateRangeFilter, NumberRangeFilter an array of strings for MultiSelectFilter, and a boolean for TriStateCheckboxFilter.

          Returns void

    • setGlobalFilter: ((value: string) => void)
        • (value: string): void

        • setGlobalFilter sets the global filter value. The global filter value is used to filter all columns.

          Parameters

          • value: string

            The global filter value

          Returns void

    • setGlobalFilterTree: ((value: Filter) => void)
        • (value: Filter): void

        • setGlobalFilterTree sets the global filter tree. The global filter tree is used to filter all columns. The global filter tree is a tree of Filter objects. The tree is used to filter the data. The tree is built by the filter builder. Please see https://reactdatagrid.com/examples/?example=Filter_Builder for more information.

          Parameters

          • value: Filter

            The global filter tree

          Returns void

    • setLockMode: ((columnIdentifier: string, lockMode: null | LockMode) => void)
        • (columnIdentifier: string, lockMode: null | LockMode): void

        • Parameters

          • columnIdentifier: string
          • lockMode: null | LockMode

          Returns void

    • setQuickFindValue: ((value: string, next: boolean) => void)
        • (value: string, next: boolean): void

        • Parameters

          • value: string
          • next: boolean

          Returns void

    • setSelectedRows: ((rowIds: string[]) => void)
        • (rowIds: string[]): void

        • setSelectedRows selects the specified rows. Only applicable if the selectionMode is set to GridSelectionMode.SingleRow or GridSelectionMode.MultipleRows (default).

          Parameters

          • rowIds: string[]

            The row identifiers to select.

          Returns void

    • setSort: ((sortInfo: {
          isAscending: boolean;
          sortColumn: string;
      }) => void)
        • (sortInfo: {
              isAscending: boolean;
              sortColumn: string;
          }): void

        • setSort sets the sort for the specified column. If the column is not sorted, it is sorted ascending. If the column is sorted ascending, it is sorted descending.

          Parameters

          • sortInfo: {
                isAscending: boolean;
                sortColumn: string;
            }
            • isAscending: boolean
            • sortColumn: string

          Returns void

    • setSorts: ((sorts: {
          isAscending: boolean;
          sortColumn: string;
      }[]) => void)
        • (sorts: {
              isAscending: boolean;
              sortColumn: string;
          }[]): void

        • setSorts sets the sorts for the specified columns. If the column is not sorted, it is sorted ascending. If the column is sorted ascending, it is sorted descending.

          Parameters

          • sorts: {
                isAscending: boolean;
                sortColumn: string;
            }[]

            An array of sort information. Each element in the array contains the column identifier and the sort direction.

          Returns void

    • shiftColumn: ((columnIdentifier?: string, nextToCell?: CellSelelection, dryRun?: boolean) => undefined | ColumnPositionInfo)
        • (columnIdentifier?: string, nextToCell?: CellSelelection, dryRun?: boolean): undefined | ColumnPositionInfo

        • Shift a column to the left or right of another column. Triggered by dragging a column header. If the column is moved to different section, for example, if a left locked column is moved to the unlocked section, the column will be unlocked in the process.

          Returns

          The cell that the column was moved next to, or undefined if the move was not valid

          Parameters

          • Optional columnIdentifier: string

            Unique column identifier of the column to move

          • Optional nextToCell: CellSelelection

            Cell to move the column next to

          • Optional dryRun: boolean

            If true, the column will not be moved, but the return value will indicate if the move is valid

          Returns undefined | ColumnPositionInfo

    • shiftRow: ((rowIdentifier?: string, nextToRowIdentifier?: string, dryRun?: boolean, above?: boolean, dragValid?: ((from: string, to: string) => boolean)) => undefined | RowPositionInfo)
        • (rowIdentifier?: string, nextToRowIdentifier?: string, dryRun?: boolean, above?: boolean, dragValid?: ((from: string, to: string) => boolean)): undefined | RowPositionInfo

        • Parameters

          • Optional rowIdentifier: string
          • Optional nextToRowIdentifier: string
          • Optional dryRun: boolean
          • Optional above: boolean
          • Optional dragValid: ((from: string, to: string) => boolean)
              • (from: string, to: string): boolean

              • Parameters

                • from: string
                • to: string

                Returns boolean

          Returns undefined | RowPositionInfo

    • showHideColumn: ((columnIdentifier: string, show: boolean) => void)
        • (columnIdentifier: string, show: boolean): void

        • Parameters

          • columnIdentifier: string
          • show: boolean

          Returns void

    • showHideContextMenu: ((show?: boolean, cell?: CellSelelection, mouseEvent?: MouseEvent) => void)
        • (show?: boolean, cell?: CellSelelection, mouseEvent?: MouseEvent): void

        • Parameters

          • Optional show: boolean
          • Optional cell: CellSelelection
          • Optional mouseEvent: MouseEvent

          Returns void

    • suspendMouseEvents: (() => void)
        • (): void

        • Returns void

    • toggleExpandCollapseColumnGroup: ((columnIdentifier: string, e: MouseEvent) => void)
        • (columnIdentifier: string, e: MouseEvent): void

        • Parameters

          • columnIdentifier: string
          • e: MouseEvent

          Returns void

    • toggleExpandCollapseRow: ((rowIdentifier: string, e: MouseEvent) => void)
        • (rowIdentifier: string, e: MouseEvent): void

        • ToggleExpandCollapseRow toggles the expansion of the specified row. Only applicable for hierarchical data.

          Parameters

          • rowIdentifier: string

            The row identifier of the row to expand or collapse.

          • e: MouseEvent

            The mouse event that triggered the toggle.

          Returns void

    • toggleSelection: ((cell: CellSelelection) => void)
        • (cell: CellSelelection): void

        • toggleSelection toggles the selection of the specified cell. Only applicable if the selectionMode is set to GridSelectionMode.SingleCell or GridSelectionMode.MultipleCells.

          Parameters

          Returns void

    • toggleSort: ((columnIdentifier: string, clearOthers?: boolean, e?: MouseEvent) => void)
        • (columnIdentifier: string, clearOthers?: boolean, e?: MouseEvent): void

        • toggleSort toggles the sort for the specified column. If the column is not sorted, it is sorted ascending. If the column is sorted ascending, it is sorted descending.

          Parameters

          • columnIdentifier: string

            The unique identifier of the column

          • Optional clearOthers: boolean

            If true, all other sorts are cleared

          • Optional e: MouseEvent

            The mouse event that triggered the sort

          Returns void

    • unlockAllColumns: (() => void)
        • (): void

        • Returns void

    • addChange:function
    • canCollapse:function
    • canExpand:function
    • cancelEdit:function
    • clearChanges:function
    • exportToExcel:function
    • exportToPdf:function
    • getChanges:function
    • getContext:function
    • pageOperation:function
      • pageOperation(operation: "first" | "last" | "previous" | "next" | "pageSizeChanged", newPageSize?: number): void

      • Parameters

        • operation: "first" | "last" | "previous" | "next" | "pageSizeChanged"
        • Optional newPageSize: number

        Returns void

    • removeChange:function
      • removeChange(rowIdentifier: string, columnIdentifier: string): void

      • Parameters

        • rowIdentifier: string
        • columnIdentifier: string

        Returns void

    • saveDefaultView:function

Settings

Member Visibility

Theme

Generated using TypeDoc