Class SunburstTooltipSettings

Configures the tooltip settings for the Sunburst chart.

Inheritance
object
ComponentBase
SunburstTooltipSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.Charts.dll
Syntax
public class SunburstTooltipSettings : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender
Remarks

The SunburstTooltipSettings component provides options for displaying and customizing tooltips in the Sunburst chart.

Tooltips display additional information about a segment when users hover over or interact with it. You can control the visibility, appearance, content format, and transparency of the tooltip.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" Fill="green" Opacity="1" />
</SfSunburstChart>

Constructors

SunburstTooltipSettings()

Declaration
public SunburstTooltipSettings()

Properties

Enable

Gets or sets a value indicating whether tooltips are displayed.

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

true to display tooltips; otherwise, false. The default value is false.
Remarks

When enabled, a tooltip is displayed when users hover over or interact with a Sunburst chart segment.

Tooltips provide additional information about a segment without requiring the information to be permanently displayed within the chart.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" />
</SfSunburstChart>

EnableHighlight

Gets or sets a value indicating whether the corresponding Sunburst chart segment is highlighted when its tooltip is displayed.

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

true to highlight the associated segment when the tooltip is shown; otherwise, false. The default value is false.
Remarks

When enabled, the chart visually emphasizes the segment associated with the displayed tooltip, making it easier for users to identify the related data point.

This feature improves the readability and interactivity of the chart by providing a clear visual connection between the tooltip and its corresponding segment.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" EnableHighlight="true" />
</SfSunburstChart>

Fill

Gets or sets the background color of the tooltip.

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

A string that specifies the tooltip background color. The default value is determined by the active Theme.
Remarks

This property controls the background appearance of the tooltip.

The color can be specified using standard CSS color formats, such as named colors, hexadecimal values, RGB values, and RGBA values.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" Fill="green" />
</SfSunburstChart>

Format

Gets or sets the format string used to display tooltip content.

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

A string that specifies the tooltip text format. The default value is Empty. When empty, the tooltip displays the label and value of the associated data point using the default format.
Remarks

This property allows you to customize the content displayed in the tooltip.

Use placeholder values to display dynamic information from the corresponding Sunburst chart segment.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" Format="${point.label}: ${point.value}" />
</SfSunburstChart>

HeaderText

Gets or sets the text displayed in the tooltip header.

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

A string that specifies the tooltip header text. The default value is Empty.
Remarks

This property allows a custom header to be displayed in the tooltip, providing additional context for the tooltip content.

When specified, the header is displayed above the tooltip content and can be used to identify the associated Sunburst chart segment.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" HeaderText="Employee" />
</SfSunburstChart>

Opacity

Gets or sets the opacity of the tooltip.

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

A double value between 0 and 1 that specifies the transparency level of the tooltip. The default value is 1.
Remarks

This property controls the transparency of the tooltip displayed in the Sunburst chart.

A value of 0 makes the tooltip fully transparent, while a value of 1 makes it fully opaque. Values between 0 and 1 produce varying levels of transparency.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" Opacity="1" />
</SfSunburstChart>

ShowHeaderLine

Gets or sets a value indicating whether a separator line is displayed beneath the tooltip header.

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

true to display the header separator line; otherwise, false. The default value is true.
Remarks

When enabled, a visual separator is rendered between the tooltip header and content, improving readability and helping distinguish the different sections of the tooltip.

Examples
<SfSunburstChart>
    <SunburstTooltipSettings Enable="true" ShowHeaderLine="false" />
</SfSunburstChart>

Implements