Class SunburstBreadcrumbSettings

Configures the text style settings for breadcrumb navigation in the Sunburst chart.

Inheritance

object

ComponentBase

SunburstBreadcrumbSettings

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 SunburstBreadcrumbSettings : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender

Remarks

The SunburstBreadcrumbSettings component provides customization options for the appearance of breadcrumb navigation, including font size, color, and separator styling.

Breadcrumb navigation is displayed when drill-down functionality is enabled and breadcrumbs are configured to be shown. Use this component to customize the visual presentation of breadcrumb items within the Sunburst chart.

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true"
                           ShowBreadcrumbs="true">
        <SunburstBreadcrumbSettings Size="13px" Color="#424242" SeparatorColor="#9e9e9e" Separator="/" />
    </SunburstDrillSettings>
</SfSunburstChart>

Constructors

SunburstBreadcrumbSettings()

Declaration

public SunburstBreadcrumbSettings()

Properties

AccessibilityDescription

Gets or sets the accessibility description applied to each breadcrumb item.

Declaration

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

Property Value

Type	Description
string	A string that specifies additional descriptive text for breadcrumb items. The default value is string.Empty.

Remarks

This property enhances accessibility by providing additional context for breadcrumb items when they are announced by assistive technologies.

When specified, the description is announced together with the breadcrumb text, helping users better understand the purpose of the navigation item.

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings AccessibilityDescription="Drill to" />
    </SunburstDrillSettings>
</SfSunburstChart>

AccessibilityRole

Gets or sets the accessibility role applied to each breadcrumb item.

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 `"button"`.

Remarks

This property helps assistive technologies understand the purpose and semantic meaning of breadcrumb items by assigning an appropriate accessibility role.

Common values include roles such as button, depending on the interactive behavior and semantic meaning of the breadcrumb item.

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings AccessibilityRole="button" />
    </SunburstDrillSettings>
</SfSunburstChart>

Color

Gets or sets the color of the breadcrumb text.

Declaration

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

Property Value

Type	Description
string	A string that specifies the color of the breadcrumb text. The default value is Empty, which means the value is inherited from the active theme.

Remarks

This property controls the color of the breadcrumb 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>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings Color="#424242" />
    </SunburstDrillSettings>
</SfSunburstChart>

Focusable

Gets or sets a value indicating whether breadcrumb items can receive keyboard focus.

Declaration

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

Property Value

Type	Description
bool	true if breadcrumb items are focusable; otherwise, false. The default value is true.

Remarks

This property improves accessibility by allowing keyboard users and assistive technologies to navigate to breadcrumb items.

When enabled, breadcrumb items can participate in the application's keyboard navigation flow, making it easier to navigate the Sunburst chart hierarchy.

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings Focusable="true" />
    </SunburstDrillSettings>
</SfSunburstChart>

FontFamily

Gets or sets the font family of the breadcrumb text.

Declaration

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

Property Value

Type	Description
string	A string that specifies the font family of the breadcrumb text, or null to inherit the value resolved by the SfSunburstChart<TItem> theme.

Remarks

This property controls the font family used to render the breadcrumb text in the Sunburst chart. When null (the default), the value resolved by the active theme is applied at render time.

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings FontFamily="Roboto" />
    </SunburstDrillSettings>
</SfSunburstChart>

FontStyle

Gets or sets the font style of the breadcrumb text.

Declaration

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

Property Value

Type	Description
string	A string that specifies the font style of the breadcrumb text, or null to inherit the value resolved by the active SfSunburstChart<TItem> theme.

Remarks

This property controls the font style used to render the breadcrumb text in the Sunburst chart. When null (the default), the value resolved by the active theme is applied at render time.

Supported values include Normal, Italic, and Oblique.

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings FontStyle="Italic" />
    </SunburstDrillSettings>
</SfSunburstChart>

FontWeight

Gets or sets the font weight of the breadcrumb text.

Declaration

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

Property Value

Type	Description
string	A string that specifies the font weight of the breadcrumb text, or null to inherit the value resolved by the active SfSunburstChart<TItem> theme.

Remarks

This property controls the font weight used to render the breadcrumb text in the Sunburst chart. When null (the default), the value resolved by the active theme is applied at render time.

Supported values include the named weights Normal and Bold, the relative weights Lighter and Bolder, or numeric weights such as "100" through "900".

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings FontWeight="Bold" />
    </SunburstDrillSettings>
</SfSunburstChart>

Format

Gets or sets the format used to compose each breadcrumb item text.

Declaration

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

Property Value

Type	Description
string	A string that specifies the format applied to breadcrumb item text. The default value is Empty.

Remarks

This property controls how breadcrumb item text is displayed in the Sunburst chart. When the value is Empty (the default), the original breadcrumb label is displayed as-is.

To wrap the label, set this property to a template containing the token ${value}, which is replaced with the breadcrumb label. For example, "Go to ${value}" produces "Go to Sales" for a breadcrumb whose label is "Sales".

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings Format="Go to ${value}" />
    </SunburstDrillSettings>
</SfSunburstChart>

Separator

Gets or sets the separator rendered between breadcrumb items.

Declaration

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

Property Value

Type	Description
string	A string that specifies the separator displayed between adjacent breadcrumb items. The default value is `"/"`.

Remarks

This property controls the character or text used to visually separate breadcrumb items in the Sunburst chart.

Common values include "/", ">", and "|".

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings Separator=">" />
    </SunburstDrillSettings>
</SfSunburstChart>

SeparatorColor

Gets or sets the color of the breadcrumb separator.

Declaration

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

Property Value

Type	Description
string	A string that specifies the color of the breadcrumb separator. The default value is Empty, which means the value is inherited from the active theme.

Remarks

This property controls the color of the separator displayed between breadcrumb items 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>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings SeparatorColor="#9e9e9e" />
    </SunburstDrillSettings>
</SfSunburstChart>

SeparatorPadding

Gets or sets the padding between a breadcrumb item and the next separator.

Declaration

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

Property Value

Type	Description
string	A string that specifies the spacing between a breadcrumb item and the adjacent separator. The default value is `"5px"`.

Remarks

This property controls the space displayed between breadcrumb items and their separators in the Sunburst chart.

The padding must be specified in pixels (for example, "5px" or "10px").

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings SeparatorPadding="8px" />
    </SunburstDrillSettings>
</SfSunburstChart>

Size

Gets or sets the font size of the breadcrumb text.

Declaration

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

Property Value

Type	Description
string	A string that specifies the font size of the breadcrumb text, or null to inherit the value resolved by the SfSunburstChart<TItem> theme.

Remarks

This property controls the size of the breadcrumb text displayed in the Sunburst chart. When null (the default), the value resolved by the active theme is applied at render time.

The font size must be specified in pixels (for example, "13px").

Examples

<SfSunburstChart>
    <SunburstDrillSettings Enable="true">
        <SunburstBreadcrumbSettings Size="13px" />
    </SunburstDrillSettings>
</SfSunburstChart>

Implements

IComponent

IHandleEvent

IHandleAfterRender