Class SunburstSubtitleSettings

Configures the appearance and accessibility of the subtitle displayed in the Sunburst chart.

Inheritance

object

ComponentBase

SunburstSubtitleSettings

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.OnInitialized()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.Charts.dll

Syntax

public class SunburstSubtitleSettings : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Remarks

The SunburstSubtitleSettings component provides customization options for the chart subtitle, including font styling, color, and accessibility attributes.

Use this component to control how the subtitle is rendered and exposed to assistive technologies.

The subtitle can be used to provide additional context, such as reporting periods, data sources, or other supporting information related to the chart.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings FontFamily="Arial" FontStyle="Normal" FontWeight="600" Size="14px" Color="#7f8c8d" AccessibilityDescription="Subtitle: Global Headcount by Region and Role" AccessibilityRole="heading" />
</SfSunburstChart>

Constructors

SunburstSubtitleSettings()

Declaration

public SunburstSubtitleSettings()

Properties

AccessibilityDescription

Gets or sets an accessible description for the chart subtitle.

Declaration

[Parameter]
public string AccessibilityDescription { get; set; }

Property Value

Type	Description
string	A string that provides additional descriptive information about the subtitle for assistive technologies. The default value is Empty.

Remarks

This property enhances accessibility by supplying a meaningful description that can be announced by screen readers, helping users better understand the purpose or context of the subtitle.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings AccessibilityDescription="Subtitle: Global Headcount by Region and Role" />
</SfSunburstChart>

AccessibilityRole

Gets or sets the accessibility role for the chart subtitle.

Declaration

[Parameter]
public string AccessibilityRole { get; set; }

Property Value

Type	Description
string	A string that specifies the semantic role exposed to assistive technologies. The default value is Empty.

Remarks

This property helps assistive technologies interpret the purpose and semantic meaning of the subtitle by assigning an appropriate accessibility role.

Common values include roles such as heading, depending on the semantic meaning of the subtitle within the application.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings AccessibilityRole="heading" />
</SfSunburstChart>

Color

Gets or sets the color of the subtitle text.

Declaration

[Parameter]
public string Color { get; set; }

Property Value

Type	Description
string	A string that specifies the subtitle text color. The default value is determined by the active Theme.

Remarks

This property controls the color of the subtitle text displayed in the Sunburst chart.

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

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings Color="#757575" />
</SfSunburstChart>

Focusable

Gets or sets a value indicating whether the subtitle receives keyboard focus when focused.

Declaration

[Parameter]
public bool Focusable { get; set; }

Property Value

Type	Description
bool	true if the subtitle can receive keyboard focus; otherwise, false. The default value is true.

Remarks

This property controls whether the subtitle participates in the chart's keyboard focus cycle.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings Focusable="false" />
</SfSunburstChart>

FontFamily

Gets or sets the font family of the subtitle text.

Declaration

[Parameter]
public string FontFamily { get; set; }

Property Value

Type	Description
string	A string that specifies the font family of the subtitle text. The default value is determined by the active Theme.

Remarks

This property controls the font family used to render the subtitle text displayed in the Sunburst chart.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings FontFamily="Arial" />
</SfSunburstChart>

FontStyle

Gets or sets the font style of the subtitle text.

Declaration

[Parameter]
public string FontStyle { get; set; }

Property Value

Type	Description
string	A string that specifies the font style of the subtitle text. The default value is determined by the active Theme.

Remarks

This property controls the style of the subtitle text displayed in the Sunburst chart.

Supported values include Normal, Italic, and Oblique.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings FontStyle="Italic" />
</SfSunburstChart>

FontWeight

Gets or sets the font weight of the subtitle text.

Declaration

[Parameter]
public string FontWeight { get; set; }

Property Value

Type	Description
string	A string that specifies the font weight of the subtitle text. The default value is determined by the active Theme.

Remarks

This property controls the thickness of the subtitle text displayed in the Sunburst chart.

Common values include Normal, Bold, Bolder, Lighter, and numeric values such as 400, 500, and 700.

Examples

<SfSunburstChart Title="Employee Distribution"
Subtitle="Global Headcount by Region and Role">
<SunburstSubtitleSettings FontWeight="600" />
</SfSunburstChart>

Position

Gets or sets the position of the subtitle within the Sunburst chart.

Declaration

[Parameter]
public SunburstTitlePosition? Position { get; set; }

Property Value

Type	Description
SunburstTitlePosition?	A nullable SunburstTitlePosition value that specifies the subtitle position. When null, the subtitle is positioned beside the title using the chart's default placement (typically just below the title when the title is at the top).

Remarks

This property controls where the subtitle is rendered within the chart area.

Supported values include Top, Bottom, Left, and Right.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings Position="SunburstTitlePosition.Bottom" />
</SfSunburstChart>

Size

Gets or sets the font size of the subtitle text.

Declaration

[Parameter]
public string Size { get; set; }

Property Value

Type	Description
string	A string that specifies the size of the subtitle text. The default value is determined by the active Theme.

Remarks

This property controls the size of the subtitle text displayed in the Sunburst chart.

Examples

<SfSunburstChart Title="Employee Distribution" Subtitle="Global Headcount by Region and Role">
    <SunburstSubtitleSettings Size="14px" />
</SfSunburstChart>

Implements

IComponent

IHandleEvent

IHandleAfterRender