Skip to content

Commit b2ea7f0

Browse files
arman-boyakhchyanarman-boyakhchyan
authored
Grids AI Assistant: Add (Update) API Descriptions Part 3 (#8815)
1 parent 9e33678 commit b2ea7f0

15 files changed

Lines changed: 57 additions & 97 deletions

File tree

‎api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommands/DataGridPredefinedCommands.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The following code snippet lists available commands with their arguments:
3131
width: number | string;
3232
};
3333
filterValue: {
34-
expression: FilterExprObj | null;
34+
expression: FilterExprTree | null;
3535
};
3636
clearFilter: {};
3737
focusRowByKey: {

api-reference/40 Common Types/15 grids/BasicFilterExprObj/BasicFilterExprObj.md renamed to api-reference/40 Common Types/15 grids/BasicFilterExpr/BasicFilterExpr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: BasicFilterExprObj
2+
id: BasicFilterExpr
33
module: common/grids
4-
export: BasicFilterExprObj
4+
export: BasicFilterExpr
55
type: Object
66
---
77
---

api-reference/40 Common Types/15 grids/CombinedFilterExprObj/CombinedFilterExprObj.md renamed to api-reference/40 Common Types/15 grids/CombinedFilterExpr/CombinedFilterExpr.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: CombinedFilterExprObj
2+
id: CombinedFilterExpr
33
module: common/grids
4-
export: CombinedFilterExprObj
4+
export: CombinedFilterExpr
55
type: Object
66
---
77
---
@@ -12,6 +12,6 @@ A combined DataGrid/TreeList filter expression.
1212
This object includes the following fields:
1313

1414
- **type**: The expression type. Set to *"combined"*.
15-
- **left**: The first filter expression.
15+
- **leftId**: The ID of the first filter expression's node ([FilterExprNode]({basewidgetpath}/FilterExprNode/)).
1616
- **combiner**: The combination operation. Accepted values: *"and"*, *"or"*.
17-
- **right**: The second filter expression.
17+
- **rightId**: The ID of the second filter expression's node ([FilterExprNode]({basewidgetpath}/FilterExprNode/)).

‎api-reference/40 Common Types/15 grids/FilterExpr/FilterExpr.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: FilterExpr
3+
module: common/grids
4+
export: FilterExpr
5+
type: BasicFilterExpr | CombinedFilterExpr | NegatedFilterExpr
6+
---
7+
---
8+
##### shortDescription
9+
A DataGrid/TreeList filter expression.
10+
11+
---
12+
**FilterExpr** is a union of multiple types whose structure depends on the represented filter expression. For additional information, see the following topics:
13+
14+
- [BasicFilterExpr](/api-reference/40%20Common%20Types/15%20grids/BasicFilterExpr '{basewidgetpath}/BasicFilterExpr/')
15+
- [CombinedFilterExpr](/api-reference/40%20Common%20Types/15%20grids/CombinedFilterExpr '{basewidgetpath}/CombinedFilterExpr/')
16+
- [NegatedFilterExpr](/api-reference/40%20Common%20Types/15%20grids/NegatedFilterExpr '{basewidgetpath}/NegatedFilterExpr/')

‎api-reference/40 Common Types/15 grids/FilterExprNode/FilterExprNode.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
id: FilterExprNode
3+
module: common/grids
4+
export: FilterExprNode
5+
---
6+
---
7+
##### shortDescription
8+
A node in a filter expression tree ([FilterExprTree]({basewidgetpath}/FilterExprTree/)).
9+
10+
---
11+
This object includes the following fields:
12+
13+
- **id**: A unique identifier for the node. Nodes reference each other by ID.
14+
- **expr**: The filter expression ([FilterExpr]({basewidgetpath}/FilterExpr/)).

‎api-reference/40 Common Types/15 grids/FilterExprObj/FilterExprObj.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎api-reference/40 Common Types/15 grids/FilterExprTree/FilterExprTree.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: FilterExprTree
3+
module: common/grids
4+
export: FilterExprTree
5+
---
6+
---
7+
##### shortDescription
8+
A complex filter expression in a flat data structure.
9+
10+
---
11+
**FilterExprTree** stores a filter expression tree as a flat list rather than a hierarchical structure. This flat structure improves compatibility with AI services for the AI Assistant's `filterValue` command.
12+
13+
This object includes the following fields:
14+
15+
- **rootId**: The ID of the root [FilterExprNode]({basewidgetpath}/FilterExprNode/). This node is evaluated first. **rootId** must match the **id** value of an object in the **nodes** array.
16+
- **nodes**: An array of [FilterExprNode]({basewidgetpath}/FilterExprNode/) objects. Each node must have a unique **id**.

api-reference/40 Common Types/15 grids/NegatedFilterExprObj/NegatedFilterExprObj.md renamed to api-reference/40 Common Types/15 grids/NegatedFilterExpr/NegatedFilterExpr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
id: NegatedFilterExprObj
2+
id: NegatedFilterExpr
33
module: common/grids
4-
export: NegatedFilterExprObj
4+
export: NegatedFilterExpr
55
type: Object
66
---
77
---
@@ -12,4 +12,4 @@ A negated ([unary NOT](/concepts/70%20Data%20Binding/5%20Data%20Layer/2%20Readin
1212
This object includes the following fields:
1313

1414
- **type**: The expression type. Set to *"negated"*.
15-
- **expression**: A filter expression ([FilterExprObj](/api-reference/40%20Common%20Types/15%20grids/FilterExprObj '{basewidgetpath}/FilterExprObj/')) to negate.
15+
- **expressionId**: The ID of a filter expression node ([FilterExprNode]({basewidgetpath}/FilterExprNode/)) to negate.

‎api-reference/40 Common Types/15 grids/PredefinedCommands/PredefinedCommands.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following code snippet lists available commands with their arguments:
3030
width: number | string;
3131
};
3232
filterValue: {
33-
expression: FilterExprObj | null;
33+
expression: FilterExprTree | null;
3434
};
3535
clearFilter: {};
3636
focusRowByKey: {

‎api-reference/NewTopics/BasicFilterExpr/BasicFilterExpr.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)