Class PivotChartTooltipSettings

Allows to customize the pivot chart tooltip.

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

Constructors

PivotChartTooltipSettings()

Declaration
public PivotChartTooltipSettings()

Properties

Border

Allows options to customize tooltip borders.

Declaration
[Parameter]
public PivotChartTooltipBorder Border { get; set; }
Property Value
Type
PivotChartTooltipBorder

Enable

Allows to set the visibility of the tooltip.

Declaration
[Parameter]
public bool Enable { get; set; }
Property Value
Type
bool

EnableAnimation

If set to true, ToolTip will animate while moving from one point to another.

Declaration
[Parameter]
public bool EnableAnimation { get; set; }
Property Value
Type
bool

EnableMarker

Allows to set the visibility of the marker.

Declaration
[Parameter]
public bool EnableMarker { get; set; }
Property Value
Type
bool

Fill

Allows to set the fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.

Declaration
[Parameter]
public string Fill { get; set; }
Property Value
Type
string

Format

Allows to set the format the ToolTip content.

Declaration
[Parameter]
public string Format { get; set; }
Property Value
Type
string

Header

Allows to set the header for tooltip.

Declaration
[Parameter]
public string Header { get; set; }
Property Value
Type
string

Opacity

Allows to set the fill color of the tooltip that accepts value in hex and rgba as a valid CSS color string.

Declaration
[Parameter]
public double Opacity { get; set; }
Property Value
Type
double

Shared

If set to true, a single ToolTip will be displayed for every index.

Declaration
[Parameter]
public bool Shared { get; set; }
Property Value
Type
bool

Template

Allows to set the custom template to format the ToolTip content. Use ${x} and ${y} as the placeholder text to display the corresponding data point.

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment<object> Template { get; set; }
Property Value
Type
RenderFragment<object>

TextStyle

Allows options to customize the ToolTip text.

Declaration
[Parameter]
public PivotChartTooltipTextStyle TextStyle { get; set; }
Property Value
Type
PivotChartTooltipTextStyle

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

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