Interface: GridApi\<TRow\>

Defined in: src/model/use-grid-api.ts:20

Imperative handle to a <DataGrid> instance. Obtain one by passing a ref (e.g. ref={gridApiRef}) and call methods on .current to drive the grid programmatically — expand/collapse, scroll, selection, export, etc.

Type Parameters

TRow

TRow

Methods

addNode()

addNode(parentId, node?, index?): string | null

Defined in: src/model/use-grid-api.ts:35

Parameters

parentId

string | null

node?

TRow

index?

number

Returns

string | null

---

autoSizeAllColumns()

autoSizeAllColumns(): void

Defined in: src/model/use-grid-api.ts:60

Auto-size every visible leaf column to its widest visible cell.

Returns

void

---

autoSizeColumn()

autoSizeColumn(columnId): void

Defined in: src/model/use-grid-api.ts:58

Auto-size the column to fit the widest visible cell.

Parameters

columnId

string

Returns

void

---

canRedo()

canRedo(): boolean

Defined in: src/model/use-grid-api.ts:49

Returns

boolean

---

canUndo()

canUndo(): boolean

Defined in: src/model/use-grid-api.ts:48

Returns

boolean

---

clearDirtyState()

clearDirtyState(): void

Defined in: src/model/use-grid-api.ts:34

Returns

void

---

collapseAll()

collapseAll(): void

Defined in: src/model/use-grid-api.ts:22

Returns

void

---

commitEdit()

commitEdit(): void

Defined in: src/model/use-grid-api.ts:27

Returns

void

---

commitRowEdit()

commitRowEdit(): void

Defined in: src/model/use-grid-api.ts:30

Returns

void

---

copy()

copy(nodeIds?): void

Defined in: src/model/use-grid-api.ts:44

Parameters

nodeIds?

string[]

Returns

void

---

cut()

cut(nodeIds?): void

Defined in: src/model/use-grid-api.ts:43

Parameters

nodeIds?

string[]

Returns

void

---

deleteNode()

deleteNode(nodeId): void

Defined in: src/model/use-grid-api.ts:36

Parameters

nodeId

string

Returns

void

---

deleteNodes()

deleteNodes(nodeIds): void

Defined in: src/model/use-grid-api.ts:37

Parameters

nodeIds

string[]

Returns

void

---

discardEdit()

discardEdit(): void

Defined in: src/model/use-grid-api.ts:28

Returns

void

---

discardRowEdit()

discardRowEdit(): void

Defined in: src/model/use-grid-api.ts:31

Returns

void

---

expandAll()

expandAll(): void

Defined in: src/model/use-grid-api.ts:21

Returns

void

---

expandRow()

expandRow(id, expanded?): void

Defined in: src/model/use-grid-api.ts:23

Parameters

id

string

expanded?

boolean

Returns

void

---

exportData()

exportData(options): Promise<void>

Defined in: src/model/use-grid-api.ts:53

Parameters

options

ExportOptions<TRow>

Returns

Promise<void>

---

exportViewState()

exportViewState(): ViewState

Defined in: src/model/use-grid-api.ts:54

Returns

ViewState

---

getChangeSet()

getChangeSet(): ChangeSet<TRow>

Defined in: src/model/use-grid-api.ts:51

Returns

ChangeSet<TRow>

---

getDirtyState()

getDirtyState(): Map<string, Map<string, unknown>>

Defined in: src/model/use-grid-api.ts:32

Returns

Map<string, Map<string, unknown>>

---

getSelectedRows()

getSelectedRows(): TRow[]

Defined in: src/model/use-grid-api.ts:25

Returns

TRow[]

---

getUndoStack()

getUndoStack(): Command<TRow>[]

Defined in: src/model/use-grid-api.ts:50

Returns

Command<TRow>[]

---

importViewState()

importViewState(state): void

Defined in: src/model/use-grid-api.ts:55

Parameters

state

ViewState

Returns

void

---

indentNode()

indentNode(nodeId): void

Defined in: src/model/use-grid-api.ts:39

Parameters

nodeId

string

Returns

void

---

isDirty()

isDirty(): boolean

Defined in: src/model/use-grid-api.ts:33

Returns

boolean

---

markClean()

markClean(): void

Defined in: src/model/use-grid-api.ts:52

Returns

void

---

moveDown()

moveDown(nodeId): void

Defined in: src/model/use-grid-api.ts:42

Parameters

nodeId

string

Returns

void

---

moveNode()

moveNode(nodeId, newParentId, index?): void

Defined in: src/model/use-grid-api.ts:38

Parameters

nodeId

string

newParentId

string | null

index?

number

Returns

void

---

moveUp()

moveUp(nodeId): void

Defined in: src/model/use-grid-api.ts:41

Parameters

nodeId

string

Returns

void

---

outdentNode()

outdentNode(nodeId): void

Defined in: src/model/use-grid-api.ts:40

Parameters

nodeId

string

Returns

void

---

paste()

paste(targetId?): void

Defined in: src/model/use-grid-api.ts:45

Parameters

targetId?

string | null

Returns

void

---

redo()

redo(): void

Defined in: src/model/use-grid-api.ts:47

Returns

void

---

scrollToRow()

scrollToRow(id): void

Defined in: src/model/use-grid-api.ts:24

Parameters

id

string

Returns

void

---

startCellEdit()

startCellEdit(rowId, columnId): void

Defined in: src/model/use-grid-api.ts:26

Parameters

rowId

string

columnId

string

Returns

void

---

startRowEdit()

startRowEdit(rowId): void

Defined in: src/model/use-grid-api.ts:29

Parameters

rowId

string

Returns

void

---

undo()

undo(): void

Defined in: src/model/use-grid-api.ts:46

Returns

void

---

whereUsed()

whereUsed(nodeId): Promise<WhereUsedResult<TRow>[]>

Defined in: src/model/use-grid-api.ts:56

Parameters

nodeId

string

Returns

Promise<WhereUsedResult<TRow>[]>