Skip to content

Commit 6742568

Browse files
DataGrid: clarify returnDataField & calculateCellValue (DevExpress#7280) (DevExpress#7282)
1 parent 19e1b7f commit 6742568

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

api-reference/10 UI Components/GridBase/3 Methods/getCombinedFilter(returnDataField).md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,16 @@ A [filter expression](/concepts/70%20Data%20Binding/5%20Data%20Layer/2%20Reading
1212
Specifies whether the total filter should contain data fields instead of [getters](/concepts/70%20Data%20Binding/5%20Data%20Layer/9%20Getters%20And%20Setters '/Documentation/Guide/Data_Binding/Data_Layer/#Getters_And_Setters').
1313

1414
---
15-
Use this method to get the total filter. This filter combines filters applied using [filtering UI elements](/concepts/05%20UI%20Components/DataGrid/30%20Filtering%20and%20Searching '/Documentation/Guide/UI_Components/{WidgetName}/Filtering_and_Searching/') and the [filter(filterExpr)](/api-reference/10%20UI%20Components/GridBase/3%20Methods/filter(filterExpr).md '{basewidgetpath}/Methods/#filterfilterExpr') method.
15+
Use this method to get the total filter that combines filters applied using [filtering UI elements](/concepts/05%20UI%20Components/DataGrid/30%20Filtering%20and%20Searching '/Documentation/Guide/UI_Components/{WidgetName}/Filtering_and_Searching/') and the [filter(filterExpr)](/api-reference/10%20UI%20Components/GridBase/3%20Methods/filter(filterExpr).md '{basewidgetpath}/Methods/#filterfilterExpr') method. **getCombinedFilter(returnDataField)** can return a filter expression that uses data fields instead of getters if you pass `true` to the **returnDataField** parameter. If you implement getters like **columns[]**.[calculateCellValue](/api-reference/_hidden/GridBaseColumn/calculateCellValue.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#calculateCellValue') in your DataGrid, set **returnDataField** to `false` or utilize the [getCombinedFilter()](/api-reference/10%20UI%20Components/GridBase/3%20Methods/getCombinedFilter().md '{basewidgetpath}/Methods/#getCombinedFilter') method.
16+
17+
For details on how to obtain all filtered and sorted rows of a DataGrid component with **getCombinedFilter(returnDataField)**, refer to the following example:
1618

1719
#include btn-open-github with {
1820
href: "https://github.com/DevExpress-Examples/devextreme-datagrid-get-all-filtered-data"
1921
}
22+
23+
For details on how to filter a Chart component's series based on a DataGrid component's filters with **getCombinedFilter(returnDataField)**, refer to the following example:
24+
2025
#include btn-open-github with {
2126
href: "https://github.com/DevExpress-Examples/devextreme-datagrid-filter-chart-series-based-on-grid-filter"
2227
}

api-reference/_hidden/GridBaseColumn/calculateCellValue.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -362,9 +362,13 @@ To invoke the default behavior, call the **defaultCalculateCellValue** function
362362

363363
---
364364

365-
#include uiwidgets-ref-functioncontext with {
366-
value: "column's configuration"
367-
}
365+
[note]
366+
367+
- The `this` keyword refers to the column's configuration.
368+
369+
- **calculateCellValue** is a [getter](/concepts/70%20Data%20Binding/5%20Data%20Layer/9%20Getters%20And%20Setters '/Documentation/Guide/Data_Binding/Data_Layer/#Getters_And_Setters'). If you implement the [getCombinedFilter(returnDataField)](/api-reference/10%20UI%20Components/GridBase/3%20Methods/getCombinedFilter(returnDataField).md '{basewidgetpath}/Methods/#getCombinedFilterreturnDataField') method, pass `false` to the **returnDataField** parameter. Alternatively, use [getCombinedFilter()](/api-reference/10%20UI%20Components/GridBase/3%20Methods/getCombinedFilter().md '{basewidgetpath}/Methods/#getCombinedFilter') instead.
370+
371+
[/note]
368372

369373
#####See Also#####
370374
- **columns[]**.[customizeText](/api-reference/_hidden/GridBaseColumn/customizeText.md '{basewidgetpath}/Configuration/columns/#customizeText')

0 commit comments

Comments
 (0)