Class SunburstLegend

Represents legend for a SfSunburstChart.

Inheritance

System.Object

SunburstLegend

Namespace: Syncfusion.UI.Xaml.SunburstChart

Assembly: Syncfusion.SfSunburstChart.WPF.dll

Syntax

public class SunburstLegend : ItemsControl

Constructors

SunburstLegend()

Initializes a new instance of the SunburstLegend class.

Declaration

public SunburstLegend()

Fields

ClickActionProperty

The DependencyProperty for ClickAction property.

Declaration

public static readonly DependencyProperty ClickActionProperty

Field Value

Type
System.Windows.DependencyProperty

DockPositionProperty

The DependencyProperty for DockPosition property.

Declaration

public static readonly DependencyProperty DockPositionProperty

Field Value

Type
System.Windows.DependencyProperty

IconHeightProperty

The DependencyProperty for IconHeight property.

Declaration

public static readonly DependencyProperty IconHeightProperty

Field Value

Type
System.Windows.DependencyProperty

IconWidthProperty

The DependencyProperty for IconWidth property.

Declaration

public static readonly DependencyProperty IconWidthProperty

Field Value

Type
System.Windows.DependencyProperty

ItemMarginProperty

The DependencyProperty for ItemMargin property.

Declaration

public static readonly DependencyProperty ItemMarginProperty

Field Value

Type
System.Windows.DependencyProperty

LegendIconProperty

The DependencyProperty for SunburstLegendIcon property.

Declaration

public static readonly DependencyProperty LegendIconProperty

Field Value

Type
System.Windows.DependencyProperty

LegendIconTemplateProperty

The DependencyProperty for LegendIconTemplate property.

Declaration

public static readonly DependencyProperty LegendIconTemplateProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

ClickAction

Gets or sets a value that determines whether to toggle corresponding segment visibility or selection while selecting the legend item.

Declaration

public LegendClickAction ClickAction { get; set; }

Property Value

Type
LegendClickAction

DockPosition

Gets or sets the position of the legend.

Declaration

public ChartDock DockPosition { get; set; }

Property Value

Type
ChartDock

IconHeight

Gets or sets height of the legend icon.

Declaration

public double IconHeight { get; set; }

Property Value

Type
System.Double

IconWidth

Gets or sets width of the legend icon.

Declaration

public double IconWidth { get; set; }

Property Value

Type
System.Double

ItemMargin

Gets or sets the margin for legend item.

Declaration

public Thickness ItemMargin { get; set; }

Property Value

Type
System.Windows.Thickness

LegendIcon

Gets or sets the legend icon type.

Declaration

public SunburstLegendIcon LegendIcon { get; set; }

Property Value

Type
SunburstLegendIcon

LegendIconTemplate

Gets or sets the custom legend icon template.

Declaration

public DataTemplate LegendIconTemplate { get; set; }

Property Value

Type
System.Windows.DataTemplate

Methods

OnMouseDown(MouseButtonEventArgs)

Called when the mouse button pressed on the SunburstLegendItem.

Declaration

protected override void OnMouseDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	Event args.

OnMouseLeave(MouseEventArgs)

Called when the mouse was leave from the chart.

Declaration

protected override void OnMouseLeave(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	Event args.

OnMouseMove(MouseEventArgs)

Called when the mouse move on the SunburstLegendItem.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseEventArgs	e	Event args.