SeriesBase.CheckedInLegend Property

Gets or sets a value that determines whether a legend check box is checked for a chart series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

NuGet Packages: DevExpress.Charts, DevExpress.WindowsDesktop.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)]
public bool CheckedInLegend { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)>
Public Property CheckedInLegend As Boolean

Property Value

Type	Description
Boolean	true, if a legend check box is checked for the series; otherwise, false.

Remarks

Use the CheckedInLegend property to control the visibility of a series. If the legend check box is checked, the series is shown on a diagram, otherwise, the series is invisible.

Note

• To control the visibility of a constant line on the diagram, ensure the check box appears on a legend (Legend.MarkerMode is set to ChechBox, CheckBoxAndMarker or MarkerAndCheckBox and the SeriesBase.CheckableInLegend property is set to true).
• For the Chart Control for ASP.NET and ASP.NET MVC, to save the state of the legend check box for series generated using a series template on callbacks, set the WebChartControl.SaveStateOnCallbacks (ChartControlSettings.SaveStateOnCallbacks) property to true.

To learn more on legend check boxes, see the corresponding section of the Legends topic.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CheckedInLegend 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-chart-create-custom-legend-radio-buttons-to-control-visibility-of-a-chart-series/CS/MainForm.cs#L22

chartControl.Legend.UseCheckBoxes = true;
chartControl.Series["Point"].CheckedInLegend = false;
chartControl.Series["Line"].CheckedInLegend = true;

how-to-preserve-the-legend-checkbox-item-state-when-the-series-items-are-created-manually-t470764/CS/dxSample/Default.aspx.cs#L34

series.DataSource = CreateTestDataTable(randomValueSeek);
series.CheckedInLegend = LoadSeriesLegendCheckState(seriesName);
return series;

win-dashboard-viewer-chartcontrol-checkedlegend-maximized/CS/CheckBoxLegendExample/CheckBoxLegend/ChartLegendHelper.cs#L65

    series.Visible = !uncheckedSeries.Contains(series.Name);
    series.CheckedInLegend = !uncheckedSeries.Contains(series.LegendTextPattern);
}

VB.NET

winforms-chart-create-custom-legend-radio-buttons-to-control-visibility-of-a-chart-series/VB/MainForm.vb#L27

chartControl.Legend.UseCheckBoxes = True
chartControl.Series("Point").CheckedInLegend = False
chartControl.Series("Line").CheckedInLegend = True

how-to-preserve-the-legend-checkbox-item-state-when-the-series-items-are-created-manually-t470764/VB/dxSample/Default.aspx.vb#L36

series.DataSource = CreateTestDataTable(randomValueSeek)
series.CheckedInLegend = LoadSeriesLegendCheckState(seriesName)
Return series

win-dashboard-viewer-chartcontrol-checkedlegend-maximized/VB/CheckBoxLegendExample/CheckBoxLegend/ChartLegendHelper.vb#L63

    series.Visible = Not uncheckedSeries.Contains(series.Name)
    series.CheckedInLegend = Not uncheckedSeries.Contains(series.LegendTextPattern)
Next series