Class PivotViewEvents<TValue>

Configures pivot view events.

Inheritance

System.Object

PivotViewEvents<TValue>

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class PivotViewEvents<TValue> : OwningComponentBase

Type Parameters

Name	Description
TValue	A type which provides schema for the pivot component.

Constructors

PivotViewEvents()

Declaration

public PivotViewEvents()

Properties

AggregateCellInfo

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

Declaration

public EventCallback<AggregateEventArgs> AggregateCellInfo { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AggregateEventArgs>

AggregateMenuOpen

It triggers before aggregate type context menu opens.

Declaration

public EventCallback<AggregateMenuOpenEventArgs> AggregateMenuOpen { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<AggregateMenuOpenEventArgs>

BeforeColumnsRender

It triggers before the columns are rendered.

Declaration

public EventCallback<ColumnRenderEventArgs> BeforeColumnsRender { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ColumnRenderEventArgs>

BeforeExport

It triggers before exporting pivot table.

Declaration

public EventCallback<BeforeExportEventArgs> BeforeExport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeforeExportEventArgs>

BeginDrillThrough

It triggers when a value cell is clicked in the pivot table for Editing.

Declaration

public EventCallback<BeginDrillThroughEventArgs> BeginDrillThrough { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<BeginDrillThroughEventArgs>

CalculatedFieldCreate

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

Declaration

public EventCallback<CalculatedFieldCreateEventArgs> CalculatedFieldCreate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CalculatedFieldCreateEventArgs>

CellClick

It triggers when a cell is clicked in the pivot table.

Declaration

public EventCallback<CellClickEventArgs> CellClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellClickEventArgs>

CellDeselected

It triggers when a cell got deselected in the pivot table.

Declaration

public EventCallback<CellDeselectEventArgs<TValue>> CellDeselected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellDeselectEventArgs<TValue>>

CellDeselecting

Triggers before any cell deselection occurs.

Declaration

public EventCallback<CellDeselectEventArgs<TValue>> CellDeselecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<CellDeselectEventArgs<TValue>>

CellSelected

It triggers when a cell got selected in the pivot table.

Declaration

public EventCallback<PivotCellSelectedEventArgs> CellSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PivotCellSelectedEventArgs>

CellSelecting

It triggers before a cell selected in pivot table.

Declaration

public EventCallback<PivotCellSelectedEventArgs> CellSelecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PivotCellSelectedEventArgs>

ChartPointClick

Triggers on chart series is point click.

Declaration

public EventCallback<PointEventArgs> ChartPointClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PointEventArgs>

ChartSeriesCreated

It triggers when the pivot chart series are created.

Declaration

public EventCallback<ChartSeriesCreatedEventArgs> ChartSeriesCreated { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ChartSeriesCreatedEventArgs>

ChartTooltipRender

Triggers before chart series is begging rendered.

Declaration

public EventCallback<TooltipRenderEventArgs> ChartTooltipRender { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<TooltipRenderEventArgs>

ConditionalFormatting

It allows to do changes before applying the conditional formatting.

Declaration

public EventCallback<ConditionalFormatSettings> ConditionalFormatting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ConditionalFormatSettings>

Created

It triggers when the pivot table component is created.

Declaration

public EventCallback<object> Created { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

DataBound

It triggers when the pivot table rendered.

Declaration

public EventCallback<object> DataBound { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Destroyed

It triggers when pivot table component getting destroyed.

Declaration

public EventCallback<object> Destroyed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Object>

Drill

It triggers before the header to be either expanded or collapsed in the pivot table.

Declaration

public EventCallback<DrillArgs<TValue>> Drill { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DrillArgs<TValue>>

DrillThrough

It triggers when a value cell is clicked in the pivot table for Drill-Through.

Declaration

public EventCallback<DrillThroughEventArgs> DrillThrough { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<DrillThroughEventArgs>

EditCompleted

It triggers when editing is made in the raw data of pivot table.

Declaration

public EventCallback<EditCompletedEventArgs<TValue>> EditCompleted { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<EditCompletedEventArgs<TValue>>

EnginePopulated

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

Declaration

public EventCallback<EnginePopulatedEventArgs> EnginePopulated { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<EnginePopulatedEventArgs>

EnginePopulating

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

Declaration

public EventCallback<EnginePopulatingEventArgs> EnginePopulating { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<EnginePopulatingEventArgs>

ExcelHeaderQueryCellInfo

The ExcelHeaderQueryCellInfoEvent event is triggered every time a data is entered into a header cell of the Excel sheet.

Declaration

public Action<ExcelHeaderQueryCellInfoEventArgs> ExcelHeaderQueryCellInfo { get; set; }

Property Value

Type	Description
System.Action<ExcelHeaderQueryCellInfoEventArgs>

ExcelQueryCellInfo

The ExcelQueryCellInfoEvent event is triggered every time a data is entered into a cell of the excel sheet. So this event is triggered as many times as the data is entered into a cell.

Declaration

public EventCallback<ExcelQueryCellInfoEventArgs<TValue>> ExcelQueryCellInfo { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ExcelQueryCellInfoEventArgs<TValue>>

ExportCompleted

The event triggers when exporting to PDF, Excel, or CSV is complete.

Declaration

public Action<object> ExportCompleted { get; set; }

Property Value

Type	Description
System.Action<System.Object>

FetchReport

It allows you to fetch the report names from specified storage.

Declaration

public EventCallback<FetchReportArgs> FetchReport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FetchReportArgs>

FieldDragStart

It triggers when a field drag (move) starts.

Declaration

public EventCallback<FieldDragStartEventArgs> FieldDragStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FieldDragStartEventArgs>

FieldDrop

It triggers before a field drops into any axis.

Declaration

public EventCallback<FieldDropEventArgs> FieldDrop { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FieldDropEventArgs>

FieldDropped

It triggers after a field dropped into the axis.

Declaration

public EventCallback<FieldDroppedEventArgs> FieldDropped { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FieldDroppedEventArgs>

FieldListRefreshed

It allows to identify whether the field list updated or not.

Declaration

public EventCallback<FieldListRefreshedEventArgs> FieldListRefreshed { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FieldListRefreshedEventArgs>

FieldRemove

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

Declaration

public EventCallback<FieldRemoveEventArgs> FieldRemove { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<FieldRemoveEventArgs>

HyperlinkCellClicked

It triggers when a hyperlink cell is clicked in the pivot table.

Declaration

public EventCallback<HyperCellClickEventArgs> HyperlinkCellClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<HyperCellClickEventArgs>

LoadReport

It allows to load the report from specified storage.

Declaration

public EventCallback<LoadReportArgs> LoadReport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LoadReportArgs>

MemberEditorOpen

It triggers before member editor dialog opens.

Declaration

public EventCallback<MemberEditorOpenEventArgs> MemberEditorOpen { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<MemberEditorOpenEventArgs>

MemberFiltering

It triggers before the filtering applied.

Declaration

public EventCallback<MemberFilteringEventArgs> MemberFiltering { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<MemberFilteringEventArgs>

NewReport

It allows to set the new report.

Declaration

public EventCallback<NewReportArgs> NewReport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<NewReportArgs>

NumberFormatting

It triggers before number format is apllied to specific field during runtime.

Declaration

public EventCallback<NumberFormattingEventArgs> NumberFormatting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<NumberFormattingEventArgs>

OnActionBegin

It triggers when UI action begins in the pivot table. The UI actions used to trigger this event such as drill down/up, value sorting, built-in toolbar options, grouping bar and field list buttons actions such as sorting, filtering, editing, aggregate type change and so on, CRUD operation in editing.

Declaration

public Action<PivotActionBeginEventArgs> OnActionBegin { get; set; }

Property Value

Type	Description
System.Action<PivotActionBeginEventArgs>

Remarks

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

Examples

<SfPivotView>
    <PivotViewEvents TValue="ProductDetails" OnActionBegin="ActionBegin"></PivotViewEvents>
</SfPivotView>

@code {
    public void ActionBegin (PivotActionBeginEventArgs args)
    {

    }
}

OnActionComplete

It triggers when UI action in the pivot table completed. The UI actions used to trigger this event such as drill down/up, value sorting, built-in toolbar options, grouping bar and field list buttons actions such as sorting, filtering, editing, aggregate type change and so on, CRUD operation in editing.

Declaration

public Action<PivotActionCompleteEventArgs<TValue>> OnActionComplete { get; set; }

Property Value

Type	Description
System.Action<PivotActionCompleteEventArgs<TValue>>

Remarks

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

Examples

<SfPivotView>
    <PivotViewEvents TValue="ProductDetails" OnActionComplete="ActionCompleted"></PivotViewEvents>
</SfPivotView>

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

    }
}

OnActionFailure

It triggers when UI action failed to achieve the desired results in the pivot table. The UI actions used to trigger this event such as drill down/up, value sorting, built-in toolbar options, grouping bar and field list buttons actions such as sorting, filtering, editing, aggregate type change and so on, CRUD operation in editing.

Declaration

public Action<PivotActionFailureEventArgs> OnActionFailure { get; set; }

Property Value

Type	Description
System.Action<PivotActionFailureEventArgs>

Remarks

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

Examples

<SfPivotView>
    <PivotViewEvents TValue="ProductDetails" OnActionFailure="ActionFailed"></PivotViewEvents>
</SfPivotView>

@code {
    public void ActionFailed (PivotActionFailureEventArgs args)
    {

    }
}

OnAxisLabelRender

Triggers before each axis label is rendered.

Declaration

public Action<AxisLabelRenderEventArgs> OnAxisLabelRender { get; set; }

Property Value

Type	Description
System.Action<AxisLabelRenderEventArgs>

OnLegendRender

Triggers before chart legend is begging rendered.

Declaration

public EventCallback<LegendRenderEventArgs> OnLegendRender { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LegendRenderEventArgs>

OnLoad

It allows any customization on the pivot table component properties on initial rendering. Based on the changes, pivot table will be redered.

Declaration

public EventCallback<LoadEventArgs<TValue>> OnLoad { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<LoadEventArgs<TValue>>

OnPointRender

Triggers before chart point is begging rendered.

Declaration

public EventCallback<PointRenderEventArgs> OnPointRender { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PointRenderEventArgs>

OnToolbarClick

It allows to change the toolbar items.

Declaration

public EventCallback<ClickEventArgs> OnToolbarClick { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ClickEventArgs>

Parent

Pivot component.

Declaration

protected SfPivotView<TValue> Parent { get; set; }

Property Value

Type	Description
SfPivotView<TValue>

PdfCellRender

It allows any customization of Pivot cell style while PDF exporting.

Declaration

public EventCallback<PdfCellRenderArgs> PdfCellRender { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PdfCellRenderArgs>

PdfHeaderQueryCellInfo

The PdfHeaderQueryCellInfoEvent event is triggered every time a data is entered into a header cell of the pdf document.

Declaration

public Action<PdfHeaderQueryCellInfoEventArgs> PdfHeaderQueryCellInfo { get; set; }

Property Value

Type	Description
System.Action<PdfHeaderQueryCellInfoEventArgs>

PdfQueryCellInfo

The PdfQueryCellInfoEvent event is triggered every time a data is entered into a cell of the pdf document. So this event is triggered as many times as the data is entered into a cell.

Declaration

public EventCallback<PdfQueryCellInfoEventArgs<TValue>> PdfQueryCellInfo { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<PdfQueryCellInfoEventArgs<TValue>>

QueryCellInfo

Triggered every time a request is made to access cell information, element, or data. It will get triggered before the cell element is appended to the Grid element.

Declaration

public EventCallback<QueryCellInfoEventArgs<TValue>> QueryCellInfo { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<QueryCellInfoEventArgs<TValue>>

RemoveReport

It allows you to remove the current report from the specified storage.

Declaration

public EventCallback<RemoveReportArgs> RemoveReport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RemoveReportArgs>

RenameReport

It allows you to rename the current report.

Declaration

public EventCallback<RenameReportArgs> RenameReport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RenameReportArgs>

ResizeStart

It triggers when column resize starts in the pivot table.

Declaration

public EventCallback<ResizeArgs> ResizeStart { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ResizeArgs>

ResizeStop

It triggers when column resize ends in the pivot table.

Declaration

public EventCallback<ResizeArgs> ResizeStop { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ResizeArgs>

RowDeselected

Triggers when a selected row is deselected.

Declaration

public EventCallback<RowDeselectEventArgs<TValue>> RowDeselected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDeselectEventArgs<TValue>>

RowDeselecting

Triggers before deselecting the selected row.

Declaration

public EventCallback<RowDeselectEventArgs<TValue>> RowDeselecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowDeselectEventArgs<TValue>>

RowSelected

Triggers after a row is selected.

Declaration

public EventCallback<RowSelectEventArgs<TValue>> RowSelected { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowSelectEventArgs<TValue>>

RowSelecting

Triggers before row selection occurs.

Declaration

public EventCallback<RowSelectingEventArgs<TValue>> RowSelecting { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<RowSelectingEventArgs<TValue>>

SaveReport

It allows you to save the report to the specified storage.

Declaration

public EventCallback<SaveReportArgs> SaveReport { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<SaveReportArgs>

ToolbarRendered

It allows to change the toolbar items.

Declaration

public EventCallback<ToolbarArgs> ToolbarRendered { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<ToolbarArgs>

Methods

Dispose(Boolean)

Dispose unmanaged resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Boolean value to dispose the object.

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
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.