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

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

PivotViewPagerSettings

Implements

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class PivotViewPagerSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

PivotViewPagerSettings()

Declaration

public PivotViewPagerSettings()

Properties

ColumnPageSizes

Gets or sets the page size list for the "Columns per page" dropdown in the pager. Default sizes: 5, 10, 20, 50, 100. Assign a list of numbers to change available sizes.

Declaration

[Parameter]
[JsonPropertyName("columnPageSizes")]
public List<int> ColumnPageSizes { get; set; }

Property Value

Type	Description
List<int>	List of integers defining available column page sizes. Default values: 5, 10, 20, 50, 100. Never null.

Examples

<SfPivotView TValue="PivotProductDetails" Height="500" Width="100%" EnablePaging="true">
    <PivotViewPagerSettings
        ColumnPageSizes="@(new List<int> { 5, 15, 25, 35, 45 })">
    </PivotViewPagerSettings>
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ...
    </PivotViewDataSourceSettings>
</SfPivotView>

EnableCompactView

Gets or sets whether the pager uses a compact view that hides paging info and shows only Previous and Next buttons.

Declaration

[Parameter]
[JsonPropertyName("enableCompactView")]
public bool EnableCompactView { get; set; }

Property Value

Type	Description
bool	A bool that enables compact view when true; disables when false. The default value is false.

Examples

<SfPivotView TValue="PivotProductDetails" Height="500" Width="100%" EnablePaging="true">
    <PivotViewPagerSettings EnableCompactView="true"></PivotViewPagerSettings>
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewGridSettings ColumnWidth="120"></PivotViewGridSettings>
</SfPivotView>

IsInversed

Gets or sets whether row and column pagers are swapped in the pager UI. Default layout places the row pager on the left and the column pager on the right. Set IsInversed to true in PivotViewPagerSettings to display the column pager on the left and the row pager on the right.

Declaration

[Parameter]
[JsonPropertyName("isInversed")]
public bool IsInversed { get; set; }

Property Value

Type	Description
bool	A bool indicating the swap state for pager placement. The default value is false.

Remarks

Default placement: row pager on the left, column pager on the right.

Applies to pager UI placement only; data ordering remains unchanged.

Examples

The following example shows how to swap row and column paging options in a PivotView:

<SfPivotView TValue="PivotProductDetails" EnablePaging=true>
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll=true>
        ....
    </PivotViewDataSourceSettings>
    <PivotViewPagerSettings IsInversed=true></PivotViewPagerSettings>
</SfPivotView>

Position

Gets or sets the pager position in the Pivot Table. Set Position in PivotViewPagerSettings to place the pager at the top or bottom of the table. The default is Bottom. Using Top places the pager above the table for layouts that prefer top navigation or alignment with other controls.

Declaration

[Parameter]
[JsonPropertyName("position")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public PagerPosition Position { get; set; }

Property Value

Type	Description
PagerPosition	One of the PagerPosition enumeration values that specifies pager placement in the Pivot Table. The default value is Bottom.

Remarks

Valid values: Top and Bottom.

Applies during rendering and updates when the Position parameter changes.

Examples

The following example shows how to set the pager position in a PivotView:

<SfPivotView TValue="PivotProductDetails" Height="500" Width="100%" EnablePaging=true>
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll=true>
        ....
    </PivotViewDataSourceSettings>
    <PivotViewPagerSettings Position=PagerPosition.Top></PivotViewPagerSettings>
</SfPivotView>

RowPageSizes

Gets or sets the page size list for the "Rows per page" dropdown in the pager. Default sizes: 10, 50, 100, 200. Assign a list of numbers to change available sizes.

Declaration

[Parameter]
[JsonPropertyName("rowPageSizes")]
public List<int> RowPageSizes { get; set; }

Property Value

Type	Description
List<int>	Al ist of integers that defines available row page sizes. The default value is `{ 10, 50, 100, 200 }`.

Examples

<SfPivotView TValue="PivotProductDetails" Height="500" Width="100%" EnablePaging="true">
    <PivotViewPagerSettings
        RowPageSizes="@(new List<int> { 10, 20, 30, 40, 50 })">
    </PivotViewPagerSettings>
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ...
    </PivotViewDataSourceSettings>
</SfPivotView>

ShowColumnPageSize

Gets or sets whether the pager shows the "Columns per page" dropdown. The dropdown lists preset or custom sizes to change columns per page at runtime.

Declaration

[Parameter]
[JsonPropertyName("showColumnPageSize")]
public bool ShowColumnPageSize { get; set; }

Property Value

Type	Description
bool	A bool that shows the "Columns per page" dropdown when true; hides when false. The default value is true.

Examples

<SfPivotView TValue="PivotProductDetails" Height="500" Width="100%" EnablePaging="true">
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewPagerSettings ShowColumnPageSize="false"></PivotViewPagerSettings>
</SfPivotView>

ShowColumnPager

Gets or sets whether the pager shows column paging options.

Declaration

[Parameter]
[JsonPropertyName("showColumnPager")]
public bool ShowColumnPager { get; set; }

Property Value

Type	Description
bool	A bool that shows column paging options when true; hides them when false. The default value is true.

Examples

<SfPivotView TValue="PivotProductDetails" EnablePaging="true">
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewPagerSettings ShowColumnPager="false"></PivotViewPagerSettings>
</SfPivotView>

ShowRowPageSize

Gets or sets whether the pager shows the "Rows per page" dropdown.

Declaration

[Parameter]
[JsonPropertyName("showRowPageSize")]
public bool ShowRowPageSize { get; set; }

Property Value

Type	Description
bool	A bool that shows the "Rows per page" dropdown when true; hides it when false. The default value is true.

Examples

<!-- Hide the "Rows per page" dropdown -->
<SfPivotView TValue="PivotProductDetails" Height="500" Width="100%" EnablePaging="true">
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewPagerSettings ShowRowPageSize="false"></PivotViewPagerSettings>
</SfPivotView>

ShowRowPager

Gets or sets whether the pager shows row paging options. Row and column pagers are controlled by PivotViewPagerSettings properties ShowRowPager and ShowColumnPager. Both are visible by default. Set ShowRowPager to false to hide the row pager.

Declaration

[Parameter]
[JsonPropertyName("showRowPager")]
public bool ShowRowPager { get; set; }

Property Value

Type	Description
bool	A bool that shows the row paging options when true; hides them when false. The default value is true.

Examples

<SfPivotView TValue="PivotProductDetails" EnablePaging="true">
    <PivotViewDataSourceSettings TValue="PivotProductDetails" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewPagerSettings ShowRowPager="false"></PivotViewPagerSettings>
</SfPivotView>

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

[Parameter]
[JsonIgnore]
public RenderFragment<PivotPagerTemplateContext> Template { get; set; }

Property Value

Type	Description
RenderFragment<PivotPagerTemplateContext>	The template content. The default value is `null`.

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(bool)

Dispose unmanaged resources in the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

OwningComponentBase.Dispose(bool)

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

ComponentBase.OnInitializedAsync()

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

ComponentBase.OnParametersSetAsync()

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable