Class PivotViewPagerSettings
Represents a class that allows configuring the paging UI option with a variety of settings, such as UI position, template and visibility to a specific axis info, such as page size and paging data.
Inheritance
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotViewPagerSettings : OwningComponentBase
Constructors
PivotViewPagerSettings()
Declaration
public PivotViewPagerSettings()
Properties
ColumnPageSizes
Gets or sets a list of values that allows you to choose the page size in the pager that will be used to display the column of the pivot table.
Declaration
public List<int> ColumnPageSizes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.Int32> | The list of values that represents the available page sizes for the column axis in the pager. The default values are 5, 10, 20, 50, and 100. |
EnableCompactView
Gets or sets a value indicating whether the pager should be displayed with minimal information by hiding all paging data except the navigation options.
Declaration
public bool EnableCompactView { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
IsInversed
Gets or sets a value indicating whether the row and column paging options are displayed as vice versa in the pager.
Declaration
public bool IsInversed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Remarks
By default, the paging options for the row axis are displayed on the left side and for the column axis on the right side.
Position
Gets or sets the position of the pager in the Pivot Table.
Declaration
public PagerPosition Position { get; set; }
Property Value
Type | Description |
---|---|
PagerPosition | One of the PagerPosition enumeration that specifies the position of pager in pivot table. The default mode is |
RowPageSizes
Gets or sets a list of values that allows you to choose the page size in the pager that will be used to display the rows of the pivot table.
Declaration
public List<int> RowPageSizes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.Int32> | The list of values that represents the available page sizes for the row axis in the pager. The default values are 10, 50, 100, and 200. |
ShowColumnPager
Gets or sets a value indicating whether to display the column paging options in the pager.
Declaration
public bool ShowColumnPager { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowColumnPageSize
Gets or sets a value indicating whether to display the column page size information in the pager.
Declaration
public bool ShowColumnPageSize { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowRowPager
Gets or sets a value indicating whether the row paging options are displayed in the pager.
Declaration
public bool ShowRowPager { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowRowPageSize
Gets or sets a value indicating whether to display the row page size information in the pager.
Declaration
public bool ShowRowPageSize { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Template
Gets or sets a template for pager UI which used to template the entire Pager UI part of pivot. The PivotPagerTemplateContext is passed as a context to the template, allowing it to access the paging information of the pivot table's rows and columns, such as the current page, page size, and total number of pages.
Declaration
public RenderFragment<PivotPagerTemplateContext> Template { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.RenderFragment<PivotPagerTemplateContext> | The template content. The default value is |
Examples
Pivot Table with pager template.
<SfPivotView TValue="PivotProductDetails" EnablePaging=true>
<PivotViewPagerSettings>
<Template>
<div style="display: grid">
<div class="pager-label">Row Pager: </div>
<SfPager PageSize="@context.RowPageSize" TotalItemsCount="@context.RowCount" CurrentPage="@context.CurrentRowPage" NumericItemsCount="5">
</SfPager>
<div class="pager-label">Column Pager: </div>
<SfPager PageSize="@context.ColumnPageSize" TotalItemsCount="@context.ColumnCount" CurrentPage="@context.CurrentColumnPage" NumericItemsCount="5">
</SfPager>
</div>
</Template>
</PivotViewPagerSettings>
</SfPivotView>
@code {
public class PivotProductDetails
{
public int Quantity { get; set; }
public double UnitPrice { get; set; }
public string ProductName { get; set; }
public string ShipCountry { get; set; }
public string ShipCity { get; set; }
}
}
Methods
Dispose()
Dispose the unmanaged resources.
Declaration
public virtual void Dispose()
Dispose(Boolean)
Dispose unmanaged resources in the component.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
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. |
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 |
---|---|
System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing any asynchronous operation. |