Class PivotViewSelectionSettings

Allows set of options to customize the selection of a row or column or cell by simply clicking on the arrow key in the pivot table. The options available are: Mode - Allow options to highlight either row wise or column wise or specific cells in the pivot table. For expample, to highlight the columns, set the property modeto Column.CellSelectionMode: Allow options to customize the mode of selection to highlight either row wise or column wise or specific cell in the pivot table. For example, to apply the selection that includes in between cells of rows within the range, set the property cellSelectionModeto Box.Type: Allow options to customize the selection type to highlight either row wise or column wise or specific cell in the pivot table. For example, to highlight multiple rows or columns or cells, set the property typeto Multiple.CheckboxOnly: Allows the selection options to highlight the rows in the pivot table using checkbox selection on their own. persistSelection: Allows you to keep selections in rows or columns or cells while performing all operations in the pivot table. CheckboxMode: Allow options to customize the checkbox selection mode in the pivot table. For example, to select multiple rows one by one through simple clicking on rows, set the property checkboxModeto Default.EnableSimpleMultiRowSelection`: Allows to perform multiple selection in rows with single clicks without using SHIFT or CTRL keys.

Inheritance

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

PivotViewSelectionSettings

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

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 PivotViewSelectionSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

PivotViewSelectionSettings()

Declaration

public PivotViewSelectionSettings()

Properties

CellSelectionMode

Allow options to customize the mode of selection to highlight either row wise or column wise or specific cell in the pivot table. For example, to apply the selection that includes in between cells of rows within the range, set the property CellSelectionMode to Box. The modes available are: Flow: Allows the range of cells to be selected between the start index and the end index, which also includes the other cells of the selected rows in the pivot table. Box: Allows you to select a range of cells within the starting and ending column indexes that are included in the range between row cells in the pivot table. BoxWithBorder: Allows the range of cells to be selected as the box mode, but along with the borders in the pivot table.

Declaration

[Parameter]
[JsonPropertyName("cellSelectionMode")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public PivotCellSelectionMode CellSelectionMode { get; set; }

Property Value

Type
PivotCellSelectionMode

CheckboxMode

Allow options to customize the checkbox selection mode in the pivot table. For example, to select multiple rows one by one through simple clicking on rows, set the property CheckboxMode to Default. The modes available are: Default: Allows multiple rows to be selected by clicking rows one by one. ResetOnRowClick: Allows you to reset the previously selected row while clicking on a specific row. You can also select multiple rows by clicking on rows along with the CTRL or SHIFT key in the pivot table.

Declaration

[Parameter]
[JsonPropertyName("checkboxMode")]
public PivotTableCheckboxSelectionType CheckboxMode { get; set; }

Property Value

Type
PivotTableCheckboxSelectionType

CheckboxOnly

Allows the selection options to highlight the rows in the pivot table using checkbox selection on their own.

To enable checkboxOnly selection, should specify the column Type as checkbox.

Declaration

[Parameter]
[JsonPropertyName("checkboxOnly")]
public bool CheckboxOnly { get; set; }

Property Value

Type
bool

EnableSimpleMultiRowSelection

Allows to perform multiple selection in rows with single clicks without using SHIFT or CTRL keys.

Declaration

[Parameter]
[JsonPropertyName("enableSimpleMultiRowSelection")]
public bool EnableSimpleMultiRowSelection { get; set; }

Property Value

Type
bool

Mode

Allow options to highlight either row wise or column wise or specific cells in the pivot table. For expample, to highlight the columns, set the property Mode to Column. The modes available are: Cell: Allows specific cells to be highlighted in the pivot table. Row: Allows the rows to be highlighted in the pivot table. Column: Allows the columns to be highlighted in the pivot table. Both: Allows both rows, columns and cells to be highlighted in the pivot table.

Declaration

[Parameter]
[JsonPropertyName("mode")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public SelectionMode Mode { get; set; }

Property Value

Type
SelectionMode

PersistSelection

Allows you to keep selections in rows or columns or cells while performing all operations in the pivot table.

For persisting selection, any one of the column should be enabled as a primary key using the Columns.isPrimaryKey property in the grid instance.

Declaration

[Parameter]
[JsonPropertyName("persistSelection")]
public bool PersistSelection { get; set; }

Property Value

Type
bool

Type

Allow options to customize the selection type to highlight either row wise or column wise or specific cell in the pivot table. For example, to highlight multiple rows or columns or cells, set the property Type to Multiple. The types available are: Single: Allows the user to select a row or cell on their own in the pivot table. Multiple: Allows the user to select multiple rows or columns or cells in the pivot table.

Declaration

[Parameter]
[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public PivotTableSelectionType Type { get; set; }

Property Value

Type
PivotTableSelectionType

Methods

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