Back to Devexpress

SunburstLabel Class

windowsforms-devexpress-dot-xtratreemap-622a967e.md

latest4.6 KB
Original Source

SunburstLabel Class

Stores the settings of sunburst item labels.

Namespace : DevExpress.XtraTreeMap

Assembly : DevExpress.XtraTreeMap.v25.2.dll

NuGet Package : DevExpress.TreeMap

Declaration

csharp
public class SunburstLabel :
    SunburstElement,
    ILabelAppearanceProvider
vb
Public Class SunburstLabel
    Inherits SunburstElement
    Implements ILabelAppearanceProvider

The following members return SunburstLabel objects:

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.

csharp
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
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:

MemberDescription
SunburstLabel.TextPatternGets or sets the pattern that formats the Sunburst’s label text.
SunburstLabel.DisplayModeSpecifies how to align a label within a sunburst item.
SunburstLabel.AutoLayoutIndicates whether the adaptive layout is enabled for sunburst item labels.
SunburstLabel.VisibleSpecifies the visibility of sunburst item labels.
SunburstControl.ItemStyleReturns the sunburst item appearance settings.
HierarchicalItemStyle.TextColorGets or sets a treemap / sunburst item text color.
SunburstItemStyle.TextGlowColorGets or sets the glow color of the sunburst item’s text.

Inheritance

Object HierarchicalElement SunburstElement SunburstLabel

See Also

SunburstLabel Members

DevExpress.XtraTreeMap Namespace