Class SunburstDrillSettings

Configures the drill-down navigation settings for the Sunburst chart.

Inheritance

object

ComponentBase

SunburstDrillSettings

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

Remarks

The SunburstDrillSettings component enables drill-down navigation across the hierarchical rings of the Sunburst chart and controls the breadcrumb navigation displayed after a drill operation.

Breadcrumb navigation helps users understand and navigate the hierarchical path of the currently focused segment. You can customize its horizontal and vertical alignment within the chart area.

Examples

<SfSunburstChart>
    <SunburstDrillSettings BreadcrumbHorizontalAlignment="BreadcrumbHorizontalAlignment.Center" BreadcrumbVerticalAlignment="BreadcrumbVerticalAlignment.Bottom" />
</SfSunburstChart>

Constructors

SunburstDrillSettings()

Declaration

public SunburstDrillSettings()

Properties

BreadcrumbHorizontalAlignment

Gets or sets the horizontal alignment of the breadcrumb navigation.

Declaration

[Parameter]
public BreadcrumbHorizontalAlignment BreadcrumbHorizontalAlignment { get; set; }

Property Value

Type	Description
BreadcrumbHorizontalAlignment	A BreadcrumbHorizontalAlignment value that specifies the horizontal position of the breadcrumb navigation. The default value is Center.

Remarks

This property determines the horizontal placement of the breadcrumb navigation within the Sunburst chart.

Left - Aligns the breadcrumb navigation to the left side of the chart.
Center - Centers the breadcrumb navigation horizontally within the chart.
Right - Aligns the breadcrumb navigation to the right side of the chart.

Examples

<SfSunburstChart>
    <SunburstDrillSettings BreadcrumbHorizontalAlignment="BreadcrumbHorizontalAlignment.Right" />
</SfSunburstChart>

BreadcrumbVerticalAlignment

Gets or sets the vertical alignment of the breadcrumb navigation.

Declaration

[Parameter]
public BreadcrumbVerticalAlignment BreadcrumbVerticalAlignment { get; set; }

Property Value

Type	Description
BreadcrumbVerticalAlignment	A BreadcrumbVerticalAlignment value that specifies the vertical position of the breadcrumb navigation. The default value is Top.

Remarks

This property determines the vertical placement of the breadcrumb navigation within the Sunburst chart.

Top - Positions the breadcrumb navigation at the top of the chart.
Bottom - Positions the breadcrumb navigation at the bottom of the chart.

Examples

<SfSunburstChart>
    <SunburstDrillSettings BreadcrumbVerticalAlignment="BreadcrumbVerticalAlignment.Bottom" />
</SfSunburstChart>

Enable

Gets or sets a value indicating whether drill-down functionality is enabled.

Declaration

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

Property Value

Type	Description
bool	true to enable drill-down functionality; otherwise, false. The default value is false.

Remarks

When enabled, users can drill down into Sunburst chart segments to explore lower levels of the hierarchy.

Drill-down navigation allows users to focus on a specific branch of the hierarchical data and view its child segments in greater detail.

Examples

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

ShowBreadcrumbs

Gets or sets a value indicating whether breadcrumb navigation is displayed.

Declaration

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

Property Value

Type	Description
bool	true to display breadcrumb navigation; otherwise, false. The default value is true.

Remarks

When enabled, breadcrumb navigation is displayed to indicate the current drill-down path within the Sunburst chart hierarchy.

Breadcrumbs help users understand their current location in the hierarchy and provide an easy way to navigate back to previous levels.

Examples

<SfSunburstChart>
    <SunburstDrillSettings ShowBreadcrumbs="true" />
</SfSunburstChart>

Implements

IComponent

IHandleEvent

IHandleAfterRender