Class PivotFieldListEvents<TValue>

Configures pivot component based events.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
PivotFieldListEvents<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotFieldListEvents<TValue> : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Type Parameters
Name
TValue

Constructors

PivotFieldListEvents()

Declaration
public PivotFieldListEvents()

Properties

AggregateCellInfo

It allows to change the each cell value during engine populating.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<AggregateEventArgs> AggregateCellInfo { get; set; }
Property Value
Type
EventCallback<AggregateEventArgs>

AggregateMenuOpen

It triggers before aggregate type context menu opens.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<AggregateMenuOpenEventArgs> AggregateMenuOpen { get; set; }
Property Value
Type
EventCallback<AggregateMenuOpenEventArgs>

CalculatedFieldCreate

It triggers before a calculated field created/edited during runtime.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<CalculatedFieldCreateEventArgs> CalculatedFieldCreate { get; set; }
Property Value
Type
EventCallback<CalculatedFieldCreateEventArgs>

Created

It trigger when the PivotFieldList component is created.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<object> Created { get; set; }
Property Value
Type
EventCallback<object>

DataBound

It trigger when the PivotFieldList rendered.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<object> DataBound { get; set; }
Property Value
Type
EventCallback<object>

Destroyed

It trigger when the PivotFieldList component getting destroyed.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<object> Destroyed { get; set; }
Property Value
Type
EventCallback<object>

EnginePopulated

It triggers after the pivot engine populated and allows to customize the pivot datasource settings.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<EnginePopulatedEventArgs> EnginePopulated { get; set; }
Property Value
Type
EventCallback<EnginePopulatedEventArgs>

EnginePopulating

It triggers before the pivot engine starts to populate and allows to customize the pivot datasource settings.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<EnginePopulatingEventArgs> EnginePopulating { get; set; }
Property Value
Type
EventCallback<EnginePopulatingEventArgs>

FieldDragStart

It trigger when a field drag (move) starts.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<FieldDragStartEventArgs> FieldDragStart { get; set; }
Property Value
Type
EventCallback<FieldDragStartEventArgs>

FieldDrop

It triggers before a field drops into any axis.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<FieldDropEventArgs> FieldDrop { get; set; }
Property Value
Type
EventCallback<FieldDropEventArgs>

FieldDropped

It trigger when a field getting dropped into any axis.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<FieldDroppedEventArgs> FieldDropped { get; set; }
Property Value
Type
EventCallback<FieldDroppedEventArgs>

FieldRemove

It triggers before removing the field from any axis during runtime.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<FieldRemoveEventArgs> FieldRemove { get; set; }
Property Value
Type
EventCallback<FieldRemoveEventArgs>

MemberEditorOpen

Occurs before the filter dialog opens when the filter icon is clicked on a specific field in the grouping bar or field list. This event allows modification of the field members displayed in the filter dialog.

Declaration
[Parameter]
[JsonIgnore]
public Action<MemberEditorOpenEventArgs> MemberEditorOpen { get; set; }
Property Value
Type
Action<MemberEditorOpenEventArgs>
Remarks

Use this event to modify the field members shown in the filter dialog or to cancel the dialog from opening.

Examples

The following example demonstrates how to use the MemberEditorOpen event to modify the field members displayed in the filter dialog or cancel its opening:

@using Syncfusion.Blazor.PivotView

<SfPivotView TValue="ExpandoObject">
    <PivotViewEvents TValue="ExpandoObject" MemberEditorOpen="OnMemberEditorOpen" />
</SfPivotView>

@code {
    public void OnMemberEditorOpen(MemberEditorOpenEventArgs args)
    {
        // Example: Modify field members or cancel the dialog
        args.Cancel = true; // Cancel opening the dialog
    }
}

MemberFiltering

It triggers before the filtering applied.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<MemberFilteringEventArgs> MemberFiltering { get; set; }
Property Value
Type
EventCallback<MemberFilteringEventArgs>

OnActionBegin

It triggers when UI action begins in the pivot field list. The UI actions used to trigger this event such as sorting fields through icon click in the field list tree, calculated field UI, button actions such as editing, sorting, filtering and aggregation.

Declaration
[Parameter]
[JsonIgnore]
public Action<PivotActionBeginEventArgs> OnActionBegin { get; set; }
Property Value
Type
Action<PivotActionBeginEventArgs>
Remarks

This event handler receives a PivotActionBeginEventArgs object that provides information about the current UI action of the pivot field list.

Examples
<SfPivotFieldList>
    <PivotFieldListEvents TValue="ProductDetails" OnActionBegin="ActionBegin"></PivotFieldListEvents>>
</SfPivotFieldList>

@code {
    public void ActionBegin (PivotActionBeginEventArgs args)
    {

    }
}

OnActionComplete

It triggers when UI action in the pivot field list completed. The UI actions used to trigger this event such as sorting fields through icon click in the field list tree, calculated field UI, button actions such as editing, sorting, filtering and aggregation.

Declaration
[Parameter]
[JsonIgnore]
public Action<PivotActionCompleteEventArgs<TValue>> OnActionComplete { get; set; }
Property Value
Type
Action<PivotActionCompleteEventArgs<TValue>>
Remarks

This event handler receives a PivotActionCompleteEventArgs<T> object that provides information about the current UI action of the pivot field list.

Examples
<SfPivotFieldList>
    <PivotFieldListEvents TValue="ProductDetails" OnActionComplete="ActionCompleted"></PivotFieldListEvents>>
</SfPivotFieldList>

@code {
    public void ActionCompleted (PivotActionCompleteEventArgs<ProductDetails> args)
    {

    }
}

OnActionFailure

It triggers when UI action failed to achieve the desired results in the pivot field list. The UI actions used to trigger this event such as sorting fields through icon click in the field list tree, calculated field UI, button actions such as editing, sorting, filtering and aggregation.

Declaration
[Parameter]
[JsonIgnore]
public Action<PivotActionFailureEventArgs> OnActionFailure { get; set; }
Property Value
Type
Action<PivotActionFailureEventArgs>
Remarks

This event handler receives a PivotActionFailureEventArgs object that provides information about the error in pivot field list. Stack trace of exceptions, if any, can also be obtained here.

Examples
<SfPivotFieldList>
    <PivotFieldListEvents TValue="ProductDetails" OnActionFailure="ActionFailed"></PivotFieldListEvents>>
</SfPivotFieldList>

@code {
    public void ActionFailed (PivotActionFailureEventArgs args)
    {

    }
}

OnLoad

It allows any customization of PivotFieldList properties on initial rendering. Based on the changes, the PivotFieldList will be rendered.

Declaration
[Parameter]
[JsonIgnore]
public EventCallback<LoadEventArgs<TValue>> OnLoad { get; set; }
Property Value
Type
EventCallback<LoadEventArgs<TValue>>

Parent

Parent component.

Declaration
[CascadingParameter]
protected SfPivotFieldList<TValue>? Parent { get; set; }
Property Value
Type
SfPivotFieldList<TValue>

ServiceInvoked

Gets or sets the delegate that is invoked after the service request has been processed by the server engine. This event is triggered when the Pivot Field List receives a response from the server, allowing you to inspect or modify the response before it is applied to the Pivot Table UI.

Declaration
[Parameter]
[JsonIgnore]
public Action<ServiceInvokedEventArgs> ServiceInvoked { get; set; }
Property Value
Type Description
Action<ServiceInvokedEventArgs>

A delegate of type Action<T> that provides access to the server response. Use this to examine or alter the response data, or to cancel further processing if necessary.
Remarks

The ServiceInvoked delegate receives an ServiceInvokedEventArgs object containing the details of the response returned from the server. You can use this to modify the response data, trigger custom actions, or cancel the default rendering behavior.

Examples

The following example demonstrates how to handle the ServiceInvoked event to prevent further processing of the server response.

@using Syncfusion.Blazor.PivotView

<SfPivotFieldList TValue="ExpandoObject">
    <PivotFieldListEvents TValue="ExpandoObject" ServiceInvoked="OnServiceInvoked" />
</SfPivotFieldList>

@code {
    public void OnServiceInvoked(ServiceInvokedEventArgs args)
    {
        // Cancel the default processing of the server response if certain conditions are met
        args.Cancel = true;
    }
}

ServiceInvoking

Gets or sets the delegate that is invoked before a service request is sent from the pivot table to the server. This allows you to customize the request sent by the pivot field list before it reaches the server.

Declaration
[Parameter]
[JsonIgnore]
public Action<ServiceInvokeEventArgs> ServiceInvoking { get; set; }
Property Value
Type Description
Action<ServiceInvokeEventArgs>

A delegate of type Action<T> that provides access to the request details. Use this to modify request parameters, headers, or custom properties before the request is dispatched.
Remarks

The ServiceInvoking delegate receives a ServiceInvokeEventArgs object containing information about the request being sent. You can use this to adjust data source settings, set custom parameters, or modify headers as needed.

Examples

The following example shows how to handle the ServiceInvoking event to modify the outgoing request.

@using Syncfusion.Blazor.PivotView

<SfPivotFieldList TValue="ExpandoObject">
    <PivotFieldListEvents TValue="ExpandoObject" ServiceInvoking="OnServiceInvoking" />
</SfPivotFieldList>

@code {
    public void OnServiceInvoking(ServiceInvokeEventArgs args)
    {
        // Enable sorting and add custom properties to the request
        args.DataSourceSettings.EnableSorting = true;
        args.CustomProperties = new { PlanId = "1234", Scenario = "Q1" };
    }
}

Methods

Dispose(bool)

Dispose unmanaged resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Boolean value to dispose the object.
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

Implements