RadzenChartTooltipOptions Class

Contains RadzenChart tooltip configuration.

Inheritance

Object

ComponentBase

RadzenChartComponentBase

RadzenChartTooltipOptions

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

RadzenChartComponentBase.SetParametersAsync

RadzenChartComponentBase.ValidateParameters

RadzenChartComponentBase.DidParameterChange

RadzenChartComponentBase.Chart

ComponentBase.BuildRenderTree

ComponentBase.OnInitialized

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSet

ComponentBase.OnParametersSetAsync

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.OnAfterRenderAsync

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenChartTooltipOptions : RadzenChartComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Constructors

RadzenChartTooltipOptionsLink to this section

Contains RadzenChart tooltip configuration.

Declaration
public RadzenChartTooltipOptions()

Properties

HighlightDataPointLink to this section

Enable or disable highlighting of the data point the tooltip refers to. When enabled an enlarged dot with a soft halo is rendered at the active data point and glides between points as the cursor moves. With Shared tooltips a dot is rendered for every series at the snapped category. On by default.

Declaration
public bool HighlightDataPoint { get; set; }
Property Value
Type Description
boolEnable or disable highlighting of the data point the tooltip refers to. When enabled an enlarged dot with a soft halo is rendered at the active data point and glides between points as the cursor moves. With Shared tooltips a dot is rendered for every series at the snapped category. On by default.

SharedLink to this section

Enable or disable shared tooltips (one tooltip displaying data for all values for the same category). By default set to false (a separate tooltip is shown for each point in the category).

Declaration
public bool Shared { get; set; }
Property Value
Type Description
boolEnable or disable shared tooltips (one tooltip displaying data for all values for the same category). By default set to false (a separate tooltip is shown for each point in the category).

SplitLink to this section

Enable split tooltips — one small tooltip box per series, each anchored near its own data point at the snapped category X. Off by default.

Declaration
public bool Split { get; set; }
Property Value
Type Description
boolEnable split tooltips — one small tooltip box per series, each anchored near its own data point at the snapped category X. Off by default.

StyleLink to this section

Gets or sets the CSS style of the tooltip.

Declaration
public string Style { get; set; }
Property Value
Type Description
stringGets or sets the CSS style of the tooltip.

TriggerLink to this section

Specifies when the tooltip is displayed. Point requires the cursor to be near a data point; Axis follows the nearest category anywhere inside the plot area. The default Auto uses Axis when the category crosshair is enabled or the chart is in a sync group.

Declaration
public ChartTooltipTrigger Trigger { get; set; }
Property Value
Type Description
ChartTooltipTriggerSpecifies when the tooltip is displayed. Point requires the cursor to be near a data point; Axis follows the nearest category anywhere inside the plot area. The default Auto uses Axis when the category crosshair is enabled or the chart is in a sync group.

VisibleLink to this section

Gets or sets a value indicating whether to show tooltips. By default RadzenChart displays tooltips.

Declaration
public bool Visible { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether to show tooltips. By default RadzenChart displays tooltips.

Methods

InitializeLink to this section

Declaration
protected override void Initialize()

ShouldRefreshChartLink to this section

Declaration
protected override bool ShouldRefreshChart(ParameterView parameters)
Parameters
Type Name Description
ParameterView parameters
Returns
Type Description
bool
An error has occurred. This app may no longer respond until reloaded. Reload 🗙