Back to Devexpress

SunburstLabel.DisplayMode Property

windowsforms-devexpress-dot-xtratreemap-dot-sunburstlabel-04283a29.md

latest4.0 KB
Original Source

SunburstLabel.DisplayMode Property

Specifies how to align a label within a sunburst item.

Namespace : DevExpress.XtraTreeMap

Assembly : DevExpress.XtraTreeMap.v25.2.dll

NuGet Package : DevExpress.TreeMap

Declaration

csharp
[DefaultValue(SunburstLabelDisplayMode.Radial)]
[XtraSerializableProperty]
public SunburstLabelDisplayMode DisplayMode { get; set; }
vb
<DefaultValue(SunburstLabelDisplayMode.Radial)>
<XtraSerializableProperty>
Public Property DisplayMode As SunburstLabelDisplayMode

Property Value

TypeDefaultDescription
SunburstLabelDisplayModeRadial

The value that defines the label display mode.

|

Available values:

NameDescription
Horizontal

Labels are drawn horizontally.

| | Radial |

Labels are drawn radially.

| | Tangent |

Labels are drawn tangentially.

|

Remarks

The following table lists the available DisplayMode property values:

ValueExample
SunburstLabelDisplayMode.Radial (default)
SunburstLabelDisplayMode.Horizontal
SunburstLabelDisplayMode.Tangent

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.

See Also

SunburstLabel Class

SunburstLabel Members

DevExpress.XtraTreeMap Namespace