Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following code snippet lists available commands with their arguments:
width: number | string;
};
filterValue: {
expression: FilterExprObj | null;
expression: FilterExprTree | null;
};
clearFilter: {};
focusRowByKey: {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: BasicFilterExprObj
id: BasicFilterExpr
module: common/grids
export: BasicFilterExprObj
export: BasicFilterExpr
type: Object
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: CombinedFilterExprObj
id: CombinedFilterExpr
module: common/grids
export: CombinedFilterExprObj
export: CombinedFilterExpr
type: Object
---
---
Expand All @@ -12,6 +12,6 @@ A combined DataGrid/TreeList filter expression.
This object includes the following fields:

- **type**: The expression type. Set to *"combined"*.
- **left**: The first filter expression.
- **leftId**: The ID of the first filter expression's node ([FilterExprNode]({basewidgetpath}/FilterExprNode/)).
- **combiner**: The combination operation. Accepted values: *"and"*, *"or"*.
- **right**: The second filter expression.
- **rightId**: The ID of the second filter expression's node ([FilterExprNode]({basewidgetpath}/FilterExprNode/)).
16 changes: 16 additions & 0 deletions api-reference/40 Common Types/15 grids/FilterExpr/FilterExpr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: FilterExpr
module: common/grids
export: FilterExpr
type: BasicFilterExpr | CombinedFilterExpr | NegatedFilterExpr
---
---
##### shortDescription
A DataGrid/TreeList filter expression.

---
**FilterExpr** is a union of multiple types that changes based on the represented filter expression. Refer to the following topics for additional information:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**FilterExpr** is a union of multiple types that changes based on the represented filter expression. Refer to the following topics for additional information:
**FilterExpr** is a union of multiple types whose structure depends on the represented filter expression. For additional information, see the following topics:


- [BasicFilterExpr](/api-reference/40%20Common%20Types/15%20grids/BasicFilterExpr '{basewidgetpath}/BasicFilterExpr/')
- [CombinedFilterExpr](/api-reference/40%20Common%20Types/15%20grids/CombinedFilterExpr '{basewidgetpath}/CombinedFilterExpr/')
- [NegatedFilterExpr](/api-reference/40%20Common%20Types/15%20grids/NegatedFilterExpr '{basewidgetpath}/NegatedFilterExpr/')
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
id: FilterExprNode
module: common/grids
export: FilterExprNode
---
Comment thread
arman-boyakhchyan marked this conversation as resolved.
Comment on lines +1 to +5
---
##### shortDescription
A node in a filter expression tree ([FilterExprTree]({basewidgetpath}/FilterExprTree/)).

---
This object includes the following fields:

- **id**: A unique identifier for the node. Nodes reference each other by ID.
- **expr**: The filter expression ([FilterExpr]({basewidgetpath}/FilterExpr/)).

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: FilterExprTree
module: common/grids
export: FilterExprTree
---
Comment thread
arman-boyakhchyan marked this conversation as resolved.
Comment on lines +1 to +5
---
##### shortDescription
A complex filter expression in a flat data structure.

---
**FilterExprTree** stores a filter expression tree in a flat list instead of a hierarchical structure. A flat data structure ensures broader AI service compatibility for the `filterValue` AI Assistant command.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**FilterExprTree** stores a filter expression tree in a flat list instead of a hierarchical structure. A flat data structure ensures broader AI service compatibility for the `filterValue` AI Assistant command.
**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.


This object includes the following fields:

- **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.
- **nodes**: An array of [FilterExprNode]({basewidgetpath}/FilterExprNode/) objects. Each node must have a unique **id**.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: NegatedFilterExprObj
id: NegatedFilterExpr
module: common/grids
export: NegatedFilterExprObj
export: NegatedFilterExpr
type: Object
---
---
Expand All @@ -12,4 +12,4 @@ A negated ([unary NOT](/concepts/70%20Data%20Binding/5%20Data%20Layer/2%20Readin
This object includes the following fields:

- **type**: The expression type. Set to *"negated"*.
- **expression**: A filter expression ([FilterExprObj](/api-reference/40%20Common%20Types/15%20grids/FilterExprObj '{basewidgetpath}/FilterExprObj/')) to negate.
- **expressionId**: The ID of a filter expression node ([FilterExprNode]({basewidgetpath}/FilterExprNode/)) to negate.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following code snippet lists available commands with their arguments:
width: number | string;
};
filterValue: {
expression: FilterExprObj | null;
expression: FilterExprTree | null;
};
clearFilter: {};
focusRowByKey: {
Expand Down
12 changes: 0 additions & 12 deletions api-reference/NewTopics/BasicFilterExpr/BasicFilterExpr.md

This file was deleted.

12 changes: 0 additions & 12 deletions api-reference/NewTopics/CombinedFilterExpr/CombinedFilterExpr.md

This file was deleted.

12 changes: 0 additions & 12 deletions api-reference/NewTopics/FilterExpr/FilterExpr.md

This file was deleted.

11 changes: 0 additions & 11 deletions api-reference/NewTopics/FilterExprNode/FilterExprNode.md

This file was deleted.

11 changes: 0 additions & 11 deletions api-reference/NewTopics/FilterExprTree/FilterExprTree.md

This file was deleted.

12 changes: 0 additions & 12 deletions api-reference/NewTopics/NegatedFilterExpr/NegatedFilterExpr.md

This file was deleted.

Loading