Class PivotViewHyperlinkSettings

Allow a set of options to display a hyperlink to link data for individual cells that are shown in the pivot table. These options allow enabling a separate hyperlink for row headers, column headers, value cells, and summary cells in the HyperlinkSettings class. The options available are: ShowHyperlink: Allows setting the visibility of hyperlink in all cells. ShowRowHeaderHyperlink: Allows setting the visibility of hyperlink in row headers. ShowColumnHeaderHyperlink: Allows setting the visibility of hyperlink in column headers. ShowValueCellHyperlink: Allows setting the visibility of hyperlink in value cells. ShowSummaryCellHyperlink: Allows setting the visibility of hyperlink in summary cells. HeaderText: Allows setting the visibility of hyperlink based on header text. ConditionalSettings: Allows setting the visibility of hyperlink based on specific condition. CssClass: Allows adding CSS class name to the hyperlink options.

Inheritance

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

PivotViewHyperlinkSettings

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

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

Constructors

PivotViewHyperlinkSettings()

Declaration

public PivotViewHyperlinkSettings()

Properties

ConditionalSettings

Gets or sets options to show or hide a hyperlink based on a condition. The options are:

Measure: Sets the value field caption to apply visibility for a specific measure.

Condition: Sets the operator, such as Equals, GreaterThan, LessThan, Between, or NotBetween.

Value1: Sets the start value.

Value2: Sets the end value. Used when the operator is Between or NotBetween.

Declaration

[Parameter]
[JsonPropertyName("conditionalSettings")]
public List<PivotViewConditionalSetting> ConditionalSettings { get; set; }

Property Value

Type	Description
List<PivotViewConditionalSetting>	A List<T> of PivotViewConditionalSetting entries that define hyperlink visibility rules. The default value is an empty collection.

Remarks

Applies to hyperlink cells configured in PivotViewHyperlinkSettings.

Each rule checks the measure and the condition against provided values and then shows or hides the hyperlink.

Use an empty collection to clear all rules.

Examples

The following example demonstrates how to use the ConditionalSettings property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings>
        <PivotViewConditionalSettings>
            <PivotViewConditionalSetting Measure="Sold" Conditions=Condition.Between Value1="100" Value2="200"></PivotViewConditionalSetting>
        </PivotViewConditionalSettings>
    </PivotViewHyperlinkSettings>
</SfPivotView>

See Also

Condition Based Hyperlink

CssClass

Adds a CSS class name to hyperlink options. Class name enables easy style application to a hyperlink in the Pivot Table.

Declaration

[Parameter]
[JsonPropertyName("cssClass")]
public string CssClass { get; set; }

Property Value

Type	Description
string	A string specifying a CSS class name applied to hyperlink options. The default value is string.Empty.

Remarks

Multiple class names separated by spaces are supported.

Class name renders on hyperlink elements in cells with hyperlink.

Use with PivotViewHyperlinkSettings and ConditionalSettings to control where hyperlink appears.

Examples

The following example demonstrates how to use the CssClass property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings CssClass="e-custom-class">
        <PivotViewConditionalSettings>
            <PivotViewConditionalSetting Measure="Sold" Conditions=Condition.Between Value1="100" Value2="200"></PivotViewConditionalSetting>
        </PivotViewConditionalSettings>
    </PivotViewHyperlinkSettings>
</SfPivotView>

<style>
.e-custom-class:hover {
    color: red !important;
}
</style>

HeaderText

Gets or sets header text used to control hyperlink visibility in cells for a specific row or column header. Uses HeaderText to enable hyperlinks only for matching headers. Configuration occurs in code-behind during initial rendering.

Declaration

[Parameter]
[JsonPropertyName("headerText")]
public string HeaderText { get; set; }

Property Value

Type	Description
string	A string specifying the header text for hyperlink filtering. The default value is string.Empty.

Remarks

Applies to row headers and column headers in PivotViewHyperlinkSettings.

Example behavior: value FY 2015 limits hyperlinks to cells matching the FY 2015 header combination.

Use an empty string to disable header-based hyperlink filtering.

Examples

The following example demonstrates how to use the HeaderText property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings HeaderText="FY 2015" CssClass="e-custom-class"></PivotViewHyperlinkSettings>
</SfPivotView>

<style>
.e-custom-class:hover {
    color: red !important;
}
</style>

ShowColumnHeaderHyperlink

Allows setting the visibility of hyperlink in column headers that are currently shown in the pivot table.The Pivot Table provides an option to display hyperlinks specifically in column header cells that are currently visible. To enable this functionality, set the ShowColumnHeaderHyperlink property to true within the PivotViewHyperlinkSettings class. This ensures that only the column headers will display hyperlinks, while other cell types remain unaffected.

Declaration

[Parameter]
[JsonPropertyName("showColumnHeaderHyperlink")]
public bool ShowColumnHeaderHyperlink { get; set; }

Property Value

Type
bool

Examples

The following example demonstrates how to use the ShowColumnHeaderHyperlink property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings ShowColumnHeaderHyperlink="true"></PivotViewHyperlinkSettings>
</SfPivotView>

See Also

Hyperlink for Column Headers

ShowHyperlink

Gets or sets a flag to show hyperlinks in all cells that are currently visible in the Pivot Table. Enable by setting ShowHyperlink to true in PivotViewHyperlinkSettings. When enabled, hyperlinks appear in row headers, column headers, value cells, and summary cells.

Declaration

[Parameter]
[JsonPropertyName("showHyperlink")]
public bool ShowHyperlink { get; set; }

Property Value

Type	Description
bool	A bool indicating visibility for hyperlinks in all visible cells. The default value is false.

Remarks

Scope: all cells visible in the current view.

Interaction: HeaderText and ConditionalSettings can limit hyperlink creation to specific headers or value ranges.

Use false to hide hyperlinks for all visible cells.

Examples

The following example demonstrates how to use the ShowHyperlink property:

<SfPivotView TValue="ProductDetails" ShowFieldList="true">
    <PivotViewDataSourceSettings DataSource="@data">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings ShowHyperlink="true">
    </PivotViewHyperlinkSettings>
</SfPivotView>

See Also

Hyperlink for All Cells

ShowRowHeaderHyperlink

Gets or sets a flag to show hyperlinks only in row header cells that are currently visible in the Pivot Table. Enable by setting ShowRowHeaderHyperlink to true in PivotViewHyperlinkSettings. Only row headers display hyperlinks; other cell types remain unchanged.

Declaration

[Parameter]
[JsonPropertyName("showRowHeaderHyperlink")]
public bool ShowRowHeaderHyperlink { get; set; }

Property Value

Type	Description
bool	A bool indicating visibility for hyperlinks in visible row header cells. The default value is false.

Remarks

Scope: row header cells only.

Use together with ShowHyperlink to control full-table visibility or with HeaderText and ConditionalSettings to limit hyperlink creation by header text or value range.

Set to false to hide hyperlinks in row header cells.

Examples

The following example demonstrates how to use the ShowRowHeaderHyperlink property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings ShowRowHeaderHyperlink="true"></PivotViewHyperlinkSettings>
</SfPivotView>

See Also

Hyperlink for Row Headers

ShowSummaryCellHyperlink

Shows hyperlinks only in summary cells that are visible in the Pivot Table. Set ShowSummaryCellHyperlink to true in PivotViewHyperlinkSettings to enable. Summary cells show hyperlinks; all other cells do not.

Declaration

[Parameter]
[JsonPropertyName("showSummaryCellHyperlink")]
public bool ShowSummaryCellHyperlink { get; set; }

Property Value

Type	Description
bool	A bool that turns hyperlink display on or off for summary cells. The default value is false.

Remarks

Scope: summary cells only.

Use with ShowHyperlink for full-table links, or use HeaderText and ConditionalSettings to limit where links appear.

Set to false to hide hyperlinks in summary cells.

Examples

The following example demonstrates how to use the ShowSummaryCellHyperlink property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings ShowSummaryCellHyperlink="true" CssClass="e-custom-class">
    </PivotViewHyperlinkSettings>
</SfPivotView>

ShowValueCellHyperlink

Shows hyperlinks only in value cells that are visible in the Pivot Table. Set ShowValueCellHyperlink to true in PivotViewHyperlinkSettings to enable. Only value cells show hyperlinks; other cells stay the same.

Declaration

[Parameter]
[JsonPropertyName("showValueCellHyperlink")]
public bool ShowValueCellHyperlink { get; set; }

Property Value

Type	Description
bool	A bool that controls hyperlink visibility for value cells. The default value is false.

Remarks

Scope: value cells only.

Use with ShowHyperlink for links in all cells. Limit by header text with HeaderText or by value range with ConditionalSettings.

Set to false to hide hyperlinks in value cells.

Examples

The following example demonstrates how to use the ShowValueCellHyperlink property:

<SfPivotView TValue="ProductDetails">
    <PivotViewDataSourceSettings DataSource="@data" ExpandAll="true">
        ....
    </PivotViewDataSourceSettings>
    <PivotViewHyperlinkSettings ShowValueCellHyperlink="true">
    </PivotViewHyperlinkSettings>
</SfPivotView>

See Also

Hyperlink for Value Cells

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

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	Boolean value to dispose the object.

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