Class PivotViewVirtualScrollSettings

Represents configuration settings for virtual scrolling in the SfPivotView<TValue> component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
PivotViewVirtualScrollSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotViewVirtualScrollSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

The PivotViewVirtualScrollSettings class controls options that influence virtual scrolling behavior and rendering strategy for large datasets. Virtualization reduces DOM size and improves rendering performance by rendering only the rows and columns required for the current viewport.

Constructors

PivotViewVirtualScrollSettings()

Declaration
public PivotViewVirtualScrollSettings()

Properties

AllowSinglePage

Gets or sets a value indicating whether virtualization renders only the current viewport page or includes adjacent pages.

Declaration
[Parameter]
[JsonPropertyName("allowSinglePage")]
public bool AllowSinglePage { get; set; }
Property Value
Type Description
bool

A bool. When set to true, only the rows and columns in the current view page are rendered during virtual scrolling. When set to false (default), the pivot table renders the current page along with the previous and next pages to support smooth navigation.
Remarks

By default, virtual scrolling renders adjacent pages (previous and next) in addition to the current page to provide smoother scrolling and quicker transitions. Rendering adjacent pages can increase DOM size and computational load for very large datasets. Setting AllowSinglePage to true restricts rendering to the current page only, which reduces the number of rendered DOM elements and improves rendering performance, especially for Blazor WebAssembly (WASM) applications.

Single-page virtualization can significantly speed up initial rendering and interactive operations such as drilling, sorting, and filtering. Evaluate this option when working with extensive datasets where minimizing rendering overhead is a priority.

Examples

Enable single-page rendering during virtual scrolling:

@using Syncfusion.Blazor.PivotView

<SfPivotView TValue="PivotVirtualData" EnableVirtualization="true" EnableValueSorting="true" ShowTooltip="false">
    <PivotViewVirtualScrollSettings AllowSinglePage="true" />
    <PivotViewDataSourceSettings DataSource="@data">
        <!-- Column, row, and value definitions -->
    </PivotViewDataSourceSettings>
</SfPivotView>
See Also

Methods

Dispose()

Dispose the unmanaged resources.

Declaration
public virtual void Dispose()

Dispose(bool)

Dispose unmanaged resources in the component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
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

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

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

Implements