LegendBase.Visibility Property

Specifies whether to show the legend on a chart.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Appearance)]
public DefaultBoolean Visibility { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Appearance)>
Public Property Visibility As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	Default - the legend visibility is defined according to the adaptive layout algoritm when the chart is resized; True - the legend is visible; False - the legend is hidden. The default is DefaultBoolean.Default.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Remarks

Use the Visibility property to show or hide the legend within a chart area.

For more information, refer to Legends.

Note

The Default returned value of the Visibility property is in affect when the adaptive layout feature is enabled. So, ensure the ChartControl.AutoLayout property is set to true.

The adaptive layout feature is used to maintain a better chart appearance and layout when the chart becomes smaller.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Visibility property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/Funnel/FunnelItemControlProvider.cs#L34

flatData = customItemData.GetFlatData(new DashboardFlatDataSourceOptions() { AddColoringColumns = true });
chart.Legend.Visibility = DevExpress.Utils.DefaultBoolean.True;
chart.Series.Clear();

winforms-heatmap-bind-to-data-source/CS/Form1.cs#L43

heatmap.Legend.Visibility = DevExpress.Utils.DefaultBoolean.True;

winforms-chart-create-and-customize-an-axis-title/CS/AxisTitle/Form1.cs#L28

// Hide the legend (if necessary).
chartControl1.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False;

winforms-dashboard-custom-items/CS/TutorialsCustomItems/CustomItems/FunnelItemControlProvider.cs#L34

flatData = customItemData.GetFlatData(new DashboardFlatDataSourceOptions() { AddColoringColumns = true });
chart.Legend.Visibility = DevExpress.Utils.DefaultBoolean.True;
chart.Series.Clear();

VB.NET

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/Funnel/FunnelItemControlProvider.vb#L40

flatData = customItemData.GetFlatData(New DashboardFlatDataSourceOptions() With {.AddColoringColumns = True})
chart.Legend.Visibility = DevExpress.Utils.DefaultBoolean.True
chart.Series.Clear()

winforms-heatmap-bind-to-data-source/VB/Form1.vb#L26

Me.heatmap.Titles.Add(New HeatmapTitle With {.Text = "Balance of Trade"})
Me.heatmap.Legend.Visibility = DevExpress.Utils.DefaultBoolean.[True]
Me.heatmap.Label.Visible = True

winforms-chart-create-and-customize-an-axis-title/VB/AxisTitle/Form1.vb#L26

' Hide the legend (if necessary).
chartControl1.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False

winforms-dashboard-custom-items/VB/TutorialsCustomItems/CustomItems/FunnelItemControlProvider.vb#L39

flatData = customItemData.GetFlatData(New DashboardFlatDataSourceOptions() With {.AddColoringColumns = True})
chart.Legend.Visibility = DevExpress.Utils.DefaultBoolean.True
chart.Series.Clear()