Class PivotViewDrilledMember

Represents a field configuration for expanding or collapsing specific member headers in a pivot table.

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

This class is used within DrilledMembers to define which field members should be drilled (expanded) or collapsed when the pivot table loads.

The members specified can be hierarchical, separated by the defined Delimiter.

Constructors

PivotViewDrilledMember()

Declaration
public PivotViewDrilledMember()

Properties

Delimiter

Gets or sets the delimiter used to separate hierarchical members.

Declaration
[Parameter]
[JsonPropertyName("delimiter")]
public string Delimiter { get; set; }
Property Value
Type Description
string

A string specifying the character or string used as a delimiter for parsing member hierarchies. The default value is Empty.
Remarks

The delimiter is used when specifying or interpreting hierarchical member paths (for example, "FY 2015~~Q1"). The delimiter value should not occur in member captions to avoid ambiguity.

Examples

The following example demonstrates how to set a custom delimiter for hierarchical members:

<SfPivotView TValue="ProductDetails" Width="800" Height="500">
  <PivotViewDataSourceSettings DataSource="@data">
    <PivotViewDrilledMembers>
      <PivotViewDrilledMember Name="Quarter" Delimiter="~~" Items="@(new string[] { "FY 2015~~Q1" })" />
      <PivotViewDrilledMember Name="Year" Items="@(new string[] { "FY 2015","FY 2016" })" />
    </PivotViewDrilledMembers>
  </PivotViewDataSourceSettings>
</SfPivotView>

Items

Gets or sets the array of member names to expand or collapse for the specified field.

Declaration
[Parameter]
[JsonPropertyName("items")]
public string[] Items { get; set; }
Property Value
Type Description
string[]

A string array containing exact member captions or hierarchical paths to target. The default value is null (no members explicitly expanded or collapsed).
Remarks

The items apply to the field identified by the enclosing Name. For hierarchical fields, provide full paths using the configured Delimiter (for example, "FY 2015~~Q1").

Behavior depends on ExpandAll:

  • When false (default), listed members are expanded on initial render.
  • When true, listed members are collapsed (exceptions to the global expand).
Examples

The following example targets hierarchical members with a custom delimiter:

<SfPivotView TValue="ProductDetails" Width="800" Height="500">
  <PivotViewDataSourceSettings DataSource="@data">
    <PivotViewDrilledMembers>
      <PivotViewDrilledMember Name="Quarter" Delimiter="~~" Items="@(new[] { "FY 2015~~Q1" })" />
    </PivotViewDrilledMembers>
  </PivotViewDataSourceSettings>
</SfPivotView>

Name

Gets or sets the field name whose members are drilled (expanded or collapsed).

Declaration
[Parameter]
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type Description
string

A string specifying the target field name. The default value is Empty.
Remarks

This value identifies the field to which the Items collection applies. For hierarchical fields, use Delimiter to specify member paths (for example, "FY 2015~~Q1").

Ensure that the field name matches a valid field in the data source; otherwise, the drill state is not applied.

Examples

The following example demonstrates how to specify the field name for drilled members:

<SfPivotView TValue="ProductDetails" Width="800" Height="500">
  <PivotViewDataSourceSettings DataSource="@data">
    <PivotViewDrilledMembers>
      <PivotViewDrilledMember Name="Country" Items="@(new string[] { "France", "Germany" })" />
    </PivotViewDrilledMembers>
  </PivotViewDataSourceSettings>
</SfPivotView>

Methods

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