Class SunburstHighlightSettings

Configures the highlight settings for the Sunburst chart.

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

The SunburstHighlightSettings component provides options for highlighting Sunburst chart segments during user interaction.

Highlighting visually emphasizes chart segments to improve focus and readability. You can control the highlight behavior, appearance, and the scope of affected segments.

Color and Opacity are independent properties that apply to the highlighted (affected) segment only. The non-highlighted segments are always de-highlighted (dimmed) when Enable is true — matching the SfChart component's _ej2_deselected CSS class behaviour, where simply enabling highlight visually emphasises the active segment by fading the rest, regardless of whether Color or Opacity is set.

Examples
<SfSunburstChart>
    <SunburstHighlightSettings Enable="true" Mode="SunburstHighlightMode.Parent" Color="orange" Opacity="0.4" />
</SfSunburstChart>

Constructors

SunburstHighlightSettings()

Declaration
public SunburstHighlightSettings()

Properties

Color

Gets or sets the color applied to highlighted segments.

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

A string that specifies the highlight color. The default value is Empty.
Remarks

This property controls the color applied to highlighted segments.

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

Color and Opacity are independent properties that apply to the highlighted (affected) segment. Setting only this property recolors the highlighted segments; setting only Opacity adjusts the highlighted segment's opacity; setting both applies both effects at the same time.

When this property is left at its default empty value, the component uses the segment's parent (or the segment itself for the root segment) color as the highlight color. This matches the SfChart component behavior so the visual identity of each segment is preserved through the highlight interaction.

Note: the non-highlighted segments are always de-highlighted (dimmed) when Enable is true — matching the SfChart component's _ej2_deselected CSS class behaviour. That dim is a fixed visual effect and is not controlled by this property; setting Color affects the highlighted segment only.

Examples
<SfSunburstChart>
    <SunburstHighlightSettings Enable="true" Color="orange" />
</SfSunburstChart>

Enable

Gets or sets a value indicating whether highlighting is enabled.

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

true to enable highlighting; otherwise, false. The default value is false.
Remarks

When enabled, Sunburst chart segments are visually highlighted during user interaction.

Highlighting helps draw attention to specific segments, making it easier for users to identify and focus on the associated data.

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

Mode

Gets or sets the highlight mode.

Declaration
[Parameter]
public SunburstHighlightMode Mode { get; set; }
Property Value
Type Description
SunburstHighlightMode

A SunburstHighlightMode value that specifies which segments are highlighted. The default value is All.
Remarks

This property determines the scope of highlighting applied when users interact with a Sunburst chart segment.

  • Single - Highlights only the interacted segment.
  • Parent - Highlights the interacted segment and its parent segments.
  • Child - Highlights the interacted segment and its child segments.
  • All - Highlights the interacted segment along with its parent and child segments.
Examples
<SfSunburstChart>
    <SunburstHighlightSettings Enable="true" Mode="SunburstHighlightMode.All" />
</SfSunburstChart>

Opacity

Gets or sets the opacity of the highlighted segment.

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 highlighted segment. The default value is 1.
Remarks

This property controls the transparency applied to the highlighted (hovered) segment itself.

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

Color and Opacity are combinable (conjected) properties: setting only Color recolors the highlighted segments, setting only Opacity adjusts the highlighted segment's opacity, and setting both applies both effects at the same time.

Note: the non-highlighted segments are always de-highlighted (dimmed) when Enable is true — matching the SfChart component's _ej2_deselected CSS class behaviour. That dim is a fixed visual effect and is not controlled by this property; setting Opacity affects the highlighted segment only.

Examples
<SfSunburstChart>
    <SunburstHighlightSettings Enable="true" Opacity="0.8" />
</SfSunburstChart>

Implements