Skip to content

Commit 4982851

Browse files
documentation(984305):Filtering topic.
1 parent a3fa87c commit 4982851

File tree

4 files changed

+26
-27
lines changed

4 files changed

+26
-27
lines changed

blazor/gantt-chart/excel-like-filter.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ control: Gantt Chart
77
documentation: ug
88
---
99

10-
# Excel like filter in Blazor Gantt component
10+
# Excel like filter in Blazor Gantt Chart component
1111

12-
The Excel-like filter in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt component enables column-level filtering similar to Microsoft Excel. It supports sorting, clearing filters, and applying advanced conditions through a submenu available in each column header. This feature is highly effective for working with large datasets and applying multiple filter criteria.
12+
The Excel-like filter in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart component enables column-level filtering similar to Microsoft Excel. It supports sorting, clearing filters, and applying advanced conditions through a submenu available in each column header. This feature is highly effective for working with large datasets and applying multiple filter criteria.
1313

1414
To enable this feature, configure [GanttFilterSettings.FilterType](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_FilterType) as **Excel** and set [AllowFiltering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_AllowFiltering) to **true**.
1515

@@ -70,7 +70,7 @@ To enable this feature, configure [GanttFilterSettings.FilterType](https://help.
7070
7171
## Customize the filter choice count
7272

73-
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt component displays up to 1000 distinct values per column in the filter dialog by default. These values are taken from the first 1000 records bound to the component and shown as checkbox list items to maintain optimal performance. Additional values can be accessed using the search option within the filter dialog.
73+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart component displays up to 1000 distinct values per column in the filter dialog by default. These values are taken from the first 1000 records bound to the component and shown as checkbox list items to maintain optimal performance. Additional values can be accessed using the search option within the filter dialog.
7474

7575
To customize this behavior, the [FilterChoiceCount](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.FilterDialogOpeningEventArgs.html#Syncfusion_Blazor_Gantt_FilterDialogOpeningEventArgs_FilterChoiceCount) property can be configured within the[FilterDialogOpening](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_FilterDialogOpening) event to increase or decrease the number of distinct values displayed, depending on the dataset size and filtering requirements.
7676

@@ -139,7 +139,7 @@ To customize this behavior, the [FilterChoiceCount](https://help.syncfusion.com/
139139
140140
## Show customized text in filter dialog
141141

142-
You can customize the text shown in the filter dialog of the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt compoenent by using the [FilterItemTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttColumn.html#Syncfusion_Blazor_Gantt_GanttColumn_FilterItemTemplate) property. This feature allows you to present meaningful labels based on the values of a specific column.
142+
You can customize the text shown in the filter dialog of the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart compoenent by using the [FilterItemTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttColumn.html#Syncfusion_Blazor_Gantt_GanttColumn_FilterItemTemplate) property. This feature allows you to present meaningful labels based on the values of a specific column.
143143

144144
In the example below, the filter checkbox list for the **Status** column is customized by defining a `FilterItemTemplate` within the column configuration. The **FilterItemTemplateContext** is used to conditionally render descriptive labels: **Completed** when the value is **true**, and **In Progress** when the value is **false**.
145145

@@ -218,7 +218,7 @@ In the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart, ther
218218

219219
The Excel filter dialog includes several features such as **context menu**, **search box**, and **checkbox list** that may not be required in some project management scenarios.
220220

221-
To remove the context menu from the filter dialog, apply the following CSS rule to the Gantt:
221+
To remove the context menu from the filter dialog, apply the following CSS rule to the Gantt Chart:
222222

223223
```cshtml
224224
<style>

blazor/gantt-chart/filter-menu.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ control: Gantt Chart
77
documentation: ug
88
---
99

10-
# Filter menu in Blazor Gantt component
10+
# Filter menu in Blazor Gantt Chart component
1111

12-
The Syncfusion Blazor Gantt component provides a filter menu for each column, allowing filtering based on data type and supported operators.
12+
The Syncfusion Blazor Gantt Chart component provides a filter menu for each column, allowing filtering based on data type and supported operators.
1313

1414
To enable this feature, configure [GanttFilterSettings.FilterType](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_FilterType) as **Menu** and set [AllowFiltering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_AllowFiltering) to **true**.
1515

1616
## Custom component in filter menu
1717

18-
You can customize the filter menu in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt component using the [FilterTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttColumn.html#Syncfusion_Blazor_Gantt_GanttColumn_FilterItemTemplate) property. This allows you to replace the default filter controls with custom components such as dropdowns or textboxes for specific columns. By default, the Gantt uses Autocomplete for string columns, NumericTextBox for number columns, DatePicker for date columns, and DropDownList for boolean column.
18+
You can customize the filter menu in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart component using the [FilterTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttColumn.html#Syncfusion_Blazor_Gantt_GanttColumn_FilterItemTemplate) property. This allows you to replace the default filter controls with custom components such as dropdowns or textboxes for specific columns. By default, the Gantt Chart uses Autocomplete for string columns, NumericTextBox for number columns, DatePicker for date columns, and DropDownList for boolean column.
1919

2020
Here is a sample code demonstrating how to render a [DropDownList](https://blazor.syncfusion.com/documentation/dropdown-list/getting-started-with-web-app) for the **TaskName** column:
2121

@@ -186,7 +186,7 @@ You can perform filtering programmatically using the [FilterByColumnAsync](https
186186

187187
## Customize the default input component of filter menu dialog
188188

189-
You can customize the input components in the filter menu of the Syncfusion Blazor Gantt by using the [FilterTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttColumn.html#Syncfusion_Blazor_Gantt_GanttColumn_FilterItemTemplate) property in `GanttColumn`. This enables column-specific customization and precise control over the behavior of individual filter components.
189+
You can customize the input components in the filter menu of the Syncfusion Blazor Gantt Chart by using the [FilterTemplate](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttColumn.html#Syncfusion_Blazor_Gantt_GanttColumn_FilterItemTemplate) property in `GanttColumn`. This enables column-specific customization and precise control over the behavior of individual filter components.
190190

191191
| Column Type | Default component |Customization | API Reference |
192192
| ----------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------- |

blazor/gantt-chart/filtering.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ control: Gantt Chart
77
documentation: ug
88
---
99

10-
# Filtering in Blazor Gantt Component
10+
# Filtering in Blazor Gantt Chart Component
1111

12-
Filtering allows you to view specific or related records based on defined criteria. The Gantt component supports options like filter menu, Excel-like filtering, and toolbar search to narrow down visible data.
12+
Filtering allows you to view specific or related records based on defined criteria. The Gantt Chart component supports options like filter menu, Excel-like filtering, and toolbar search to narrow down visible data.
1313

14-
To enable filtering, set [AllowFiltering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_AllowFiltering) to **true** in the Gantt configuration. You can define filter options using `GanttFilterSettings` and configure toolbar search using `GanttSearchSettings` property.
14+
To enable filtering, set [AllowFiltering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_AllowFiltering) to **true** in the Gantt Chart configuration. You can define filter options using `GanttFilterSettings` and configure toolbar search using `GanttSearchSettings` property.
1515

1616
> The filtering UI is rendered based on the column type, allowing data to be filtered using appropriate operators.
1717
> The filter menu is enabled by default. To disable the filtering option for a specific column, set the `AllowFiltering` property of the `GanttColumn` to **false**.
@@ -69,7 +69,7 @@ To enable filtering, set [AllowFiltering](https://help.syncfusion.com/cr/blazor/
6969

7070
## Filter hierarchy modes
7171

72-
The Blazor Gantt component supports multiple filtering modes, which can be configured using the [GanttFilterSettings.HierarchyMode](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_HierarchyMode) property. The available modes are:
72+
The Blazor Gantt Chart component supports multiple filtering modes, which can be configured using the [GanttFilterSettings.HierarchyMode](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_HierarchyMode) property. The available modes are:
7373

7474
- **Parent**: This is the default mode. Filtered records are displayed along with their parent records. If no parent exists, only the filtered records are shown.
7575

@@ -82,7 +82,6 @@ The Blazor Gantt component supports multiple filtering modes, which can be confi
8282
{% tabs %}
8383
{% highlight razor tabtitle="Index.razor" %}
8484

85-
@page "/__Index"
8685
@using Syncfusion.Blazor.Gantt
8786
@using Syncfusion.Blazor.DropDowns
8887

@@ -164,7 +163,7 @@ The Blazor Gantt component supports multiple filtering modes, which can be confi
164163

165164
## Initial filter
166165

167-
To apply filtering during the initial render of the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt component, define the filter conditions using a collection of `PredicateModel` objects within the [GanttFilterSettings.Columns](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_Columns) property.
166+
To apply filtering during the initial render of the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart component, define the filter conditions using a collection of `PredicateModel` objects within the [GanttFilterSettings.Columns](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_Columns) property.
168167

169168
The following sample demonstrates how to apply an initial filter where **TaskName** starts with **Identify** and **TaskID** equals **2**, using a `Predicate` condition set to **and**.
170169

@@ -248,7 +247,7 @@ N> By default, the `GanttFilterSettings.Columns.Operator` value is `equal`
248247

249248
## Diacritics
250249

251-
By default, the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt component ignores diacritic characters during filtering. To enable filtering with diacritic sensitivity, set the [GanttFilterSettings.IgnoreAccent](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_IgnoreAccent) property to **true**.
250+
By default, the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart component ignores diacritic characters during filtering. To enable filtering with diacritic sensitivity, set the [GanttFilterSettings.IgnoreAccent](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttFilterSettings.html#Syncfusion_Blazor_Gantt_GanttFilterSettings_IgnoreAccent) property to **true**.
252251

253252
The following sample demonstrates this behavior: when filtering the **TaskName** column, entries containing diacritic characters (e.g., “Próject”, “Projéct”) will be matched if you enter the base text **Project**.
254253

@@ -305,7 +304,7 @@ The following sample demonstrates this behavior: when filtering the **TaskName**
305304

306305
## Filtering a specific column by method
307306

308-
You can filter columns dynamically in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt component by using the [FilterByColumnAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_FilterByColumnAsync_System_String_System_String_System_String_) method.
307+
You can filter columns dynamically in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Gantt Chart component by using the [FilterByColumnAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_FilterByColumnAsync_System_String_System_String_System_String_) method.
309308

310309
The example below demonstrates how to filter the **TaskName** and **TaskID** columns using a single value. Filtering is triggered by an external button click, which invokes the `FilterByColumnAsync` method.
311310

@@ -370,7 +369,7 @@ The example below demonstrates how to filter the **TaskName** and **TaskID** col
370369

371370
## Clear filtered columns
372371

373-
You can clear all the filtering conditions applied in the Gantt component by using the [ClearFilteringAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_ClearFilteringAsync) method.
372+
You can clear all the filtering conditions applied in the Gantt Chart component by using the [ClearFilteringAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_ClearFilteringAsync) method.
374373

375374
{% tabs %}
376375
{% highlight razor tabtitle="Index.razor" %}
@@ -441,7 +440,7 @@ You can clear all the filtering conditions applied in the Gantt component by usi
441440

442441
## Enable different filter for a column
443442

444-
You can enable different filter types for individual columns in the Syncfusion<sup style="font-size:70%">&reg;</sup> Gantt component by setting the[GanttColumn.FilterSettings.Type](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.FilterSettings.html#Syncfusion_Blazor_Grids_FilterSettings_Type) property.
443+
You can enable different filter types for individual columns in the Syncfusion<sup style="font-size:70%">&reg;</sup> Gantt Chart component by setting the[GanttColumn.FilterSettings.Type](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.FilterSettings.html#Syncfusion_Blazor_Grids_FilterSettings_Type) property.
445444

446445
{% tabs %}
447446
{% highlight razor tabtitle="Index.razor" %}
@@ -568,7 +567,7 @@ You can enable different filter types for individual columns in the Syncfusion<s
568567

569568
## Get filtered records
570569

571-
You can retrieve filtered records from the Gantt component using the [GetFilteredRecordsAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_GetFilteredRecordsAsync) method.
570+
You can retrieve filtered records from the Gantt Chart component using the [GetFilteredRecordsAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.SfGantt-1.html#Syncfusion_Blazor_Gantt_SfGantt_1_GetFilteredRecordsAsync) method.
572571

573572
{% tabs %}
574573
{% highlight razor tabtitle="Index.razor" %}
@@ -674,7 +673,7 @@ You can retrieve filtered records from the Gantt component using the [GetFiltere
674673

675674
## Customize filtering action
676675

677-
You can customize the filtering behavior in the Gantt component using the [FilterDialogOpening](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_FilterDialogOpening), [FilterDialogOpened](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_FilterDialogOpened), [Filtering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_Filtering), and [Filtered](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_Filtered) events.
676+
You can customize the filtering behavior in the Gantt Chart component using the [FilterDialogOpening](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_FilterDialogOpening), [FilterDialogOpened](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_FilterDialogOpened), [Filtering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_Filtering), and [Filtered](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Gantt.GanttEvents-1.html#Syncfusion_Blazor_Gantt_GanttEvents_1_Filtered) events.
678677

679678
The following `Filtering` event cancels the filter action for the **TaskName** column.
680679

0 commit comments

Comments
 (0)