Class SunburstSelectionSettings

Configures the selection settings for the Sunburst chart.

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

The SunburstSelectionSettings component provides options for selecting Sunburst chart segments during user interaction.

Selection allows users to visually identify and focus on specific segments within the chart. You can control the selection behavior, appearance, and the scope of affected segments.

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

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

Constructors

SunburstSelectionSettings()

Declaration
public SunburstSelectionSettings()

Properties

Color

Gets or sets the color applied to selected segments.

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

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

This property controls the color applied to selected 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 selected (affected) segment. Setting only this property recolors the selected segment; setting only Opacity adjusts the selected 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 selection color. This matches the SfChart component behavior so the visual identity of each segment is preserved through the selection interaction.

Note: the non-selected 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 selected segment only.

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

Enable

Gets or sets a value indicating whether selection is enabled.

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

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

When enabled, users can select Sunburst chart segments through mouse, touch, or keyboard interaction.

Selection helps users focus on specific segments and visually distinguish them from the remaining chart data.

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

Mode

Gets or sets the selection mode.

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

A SunburstSelectionMode value that specifies which segments are selected. The default value is All.
Remarks

This property determines the scope of selection applied when users select a Sunburst chart segment.

  • Single - Selects only the selected segment.
  • Parent - Selects the selected segment and its parent segments.
  • Child - Selects the selected segment and its child segments.
  • All - Selects the selected segment along with its parent and child segments.
Examples
<SfSunburstChart>
    <SunburstSelectionSettings Enable="true" Mode="SunburstSelectionMode.All" />
</SfSunburstChart>

Opacity

Gets or sets the opacity of the selected 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 selected segment. The default value is 1.
Remarks

This property controls the transparency applied to the selected segment itself.

A value of 0 makes the selected 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 selected segment, setting only Opacity adjusts the selected segment's opacity, and setting both applies both effects at the same time.

Note: the non-selected 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 selected segment only.

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

Implements