SunburstControl.Label Property

Returns the sunburst item label settings.

Namespace: DevExpress.XtraTreeMap

Assembly: DevExpress.XtraTreeMap.v23.2.UI.dll

NuGet Package: DevExpress.Win.TreeMap

Declaration

C#

[XtraSerializableProperty(XtraSerializationVisibility.Hidden)]
public SunburstLabel Label { get; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Hidden)>
Public ReadOnly Property Label As SunburstLabel

Property Value

Type	Description
SunburstLabel	The settings of sunburst item labels.

Remarks

The Label property provides access to the SunburstLabel object that stores the item label representation options.

To provide item labels with content, use the appropriate data adapter’s properties:

• SunburstFlatDataAdapter.LabelDataMember for the Flat data adapter;
• HierarchicalDataMapping.LabelDataMember for the Hierarchical data adapter;
• SunburstItem.Label for manually created items that the Sunburst control stores in the Item Storage.

Example

This example demonstrates how to format content and fine-tune the appearance of sunburst item labels.

Use the following API members to customize label text format, appearance and arrangement.

C#

sunburstControl.Label.TextPattern = "{L}: ${V:F2}M";
sunburstControl.Label.DisplayMode = SunburstLabelDisplayMode.Horizontal;
sunburstControl.Label.AutoLayout = true;
sunburstControl.Label.Visible = true;
sunburstControl.ItemStyle.TextColor = Color.DarkSlateBlue;
sunburstControl.ItemStyle.TextGlowColor = Color.White;

VB.NET

sunburstControl.Label.TextPattern = "{L}: ${V:F2}M"
sunburstControl.Label.DisplayMode = SunburstLabelDisplayMode.Horizontal
sunburstControl.Label.AutoLayout = true
sunburstControl.Label.Visible = true
sunburstControl.ItemStyle.TextColor = Color.DarkSlateBlue
sunburstControl.ItemStyle.TextGlowColor = Color.White

The example above uses the following API members:

Member	Description
SunburstLabel.TextPattern	Gets or sets the pattern that formats the Sunburst’s label text.
SunburstLabel.DisplayMode	Specifies how to align a label within a sunburst item.
SunburstLabel.AutoLayout	Indicates whether the adaptive layout is enabled for sunburst item labels.
SunburstLabel.Visible	Specifies the visibility of sunburst item labels.
SunburstControl.ItemStyle	Returns the sunburst item appearance settings.
HierarchicalItemStyle.TextColor	Gets or sets a treemap / sunburst item text color.
SunburstItemStyle.TextGlowColor	Gets or sets the glow color of the sunburst item’s text.