Class GanttFilterSettings

Configures the filter settings for Gantt.

Inheritance
object
ComponentBase
GanttFilterSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Gantt
Assembly: Syncfusion.Blazor.dll
Syntax
public class GanttFilterSettings : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Constructors

GanttFilterSettings()

Declaration
public GanttFilterSettings()

Properties

Columns

Gets or sets the list of columns to be filtered at initial rendering of the Gantt chart.

Declaration
[Parameter]
public List<PredicateModel> Columns { get; set; }
Property Value
Type Description
List<PredicateModel>

A list of PredicateModel objects representing the columns to be filtered at the initial rendering of the Gantt chart.
Remarks

Use this property to specify the columns that should be filtered at the initial rendering of the Gantt chart. To get the columns that are currently filtered, access this property after the chart has been rendered.

FilterType

Gets or sets the filtering type for the Gantt chart component.

Declaration
[Parameter]
public FilterType FilterType { get; set; }
Property Value
Type Description
FilterType

A FilterType enumeration value specifying the filter interface style. The default value is Menu.
Remarks

When set to Excel, enables advanced filtering features including:

  • Checkbox-based multi-selection interface
  • Search functionality within filter values
  • Custom filter item templates via FilterItemTemplate
  • Condition-based filtering options

HierarchyMode

Gets or sets the filter hierarchy mode for the gantt chart. The available options are, Parent: Shows the filtered record with parent record. Child: Shows the filtered record with child record. Both : shows the filtered record with both parent and child record. None : Shows only filtered record.

Declaration
[Parameter]
public FilterHierarchyMode HierarchyMode { get; set; }
Property Value
Type Description
FilterHierarchyMode

A FilterHierarchyMode value that specifies how the records should be filtered in the chart.
Remarks

Use this property to set the filter hierarchy mode for the Gantt chart.

IgnoreAccent

Gets or sets a value that indicates whether the filter should ignores the diacritic characters or accents while filtering.

Declaration
[Parameter]
public bool IgnoreAccent { get; set; }
Property Value
Type Description
bool

true if diacritic characters or accents should be ignored; otherwise, false.
Remarks

Use this property to specify whether the filter should ignore diacritic characters or accents while filtering. If this property is set to true, then the filter will ignore diacritic characters or accents while filtering. By default, this property is set to false, which means that diacritic characters or accents are taken into account while filtering.

Operators

Gets or sets a value that allows you to customize the filter operations.

Declaration
[Parameter]
public object Operators { get; set; }
Property Value
Type Description
object

An object that defines custom filter operators for specific data types.
Remarks

Use this property to customize the filter operators that are displayed in the filter menu for specific data types. The Operators property should be defined by data type (string, number, date, and boolean). Based on the data type of the column, the customized operator list will be rendered in the filter menu.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Triggers during the initial rendering of the component.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A Task representing the asynchronous operation.
Overrides

OnParametersSetAsync()

Called by the framework when component parameters have been set. Executes logic that depends on the updated parameter values.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements