SunburstLabel Class

Stores the settings of sunburst item labels.

Namespace: DevExpress.XtraTreeMap

Assembly: DevExpress.XtraTreeMap.v24.2.dll

Declaration

C#

public class SunburstLabel :
    SunburstElement,
    ILabelAppearanceProvider

VB.NET

Public Class SunburstLabel
    Inherits SunburstElement
    Implements ILabelAppearanceProvider

Related API Members

The following members return SunburstLabel objects:

• SunburstControl.Label

Remarks

The SunburstControl.Label property provides access to label options.

• Use TextPattern to define the label text format.

• To specify the label alignment, specify the DisplayMode property.

• The AutoLayout property defines whether the adaptive layout is enabled for labels.

The text style settings is available via the sunburst item style options. The SunburstControl.ItemStyle property allows you to specify a common style for all sunburst items. You can use the SunburstItem.Style property to access the particular label’s settings. Use HierarchicalItemStyle.TextColor and SunburstItemStyle.TextGlowColor properties to customize the label text appearance.

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.

Inheritance

Object

HierarchicalElement

SunburstElement

SunburstLabel