Interface IChartDataTable

Represents the chart data table.

Namespace: Syncfusion.XlsIO
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public interface IChartDataTable

Properties

HasBorders

True if the data table has outline borders. otherwise False. The default value is True.

Declaration
bool HasBorders { get; set; }
Property Value
Type
System.Boolean
Examples

The following code illustrates how to outline borders of IChartDataTable object.

        using (ExcelEngine excelEngine = new ExcelEngine())
        {
            //Create worksheet
            IApplication application = excelEngine.Excel;
            application.DefaultVersion = ExcelVersion.Excel2013;
            IWorkbook workbook = application.Workbooks.Create(1);
            IWorksheet sheet = workbook.Worksheets[0];

            //Add data
            sheet.Range["A1"].Text = "Jan";
            sheet.Range["B1"].Text = "Feb";
            sheet.Range["C1"].Text = "Mar";
            sheet.Range["A2"].Value = "10";
            sheet.Range["B2"].Value = "20";
            sheet.Range["C2"].Value = "30";
            sheet.Range["A3"].Value = "15";
            sheet.Range["B3"].Value = "25";
            sheet.Range["C3"].Value = "35";

            //Create chart
            IChart chart = sheet.Charts.Add();

            //Set range
            chart.DataRange = sheet.Range["A1:C3"];

            //Set chart type
            chart.ChartType = ExcelChartType.Column_Clustered;

            //Enabling the data table
            chart.HasDataTable = true;

            //Get data table of the chart
            IChartDataTable dataTable = chart.DataTable;

            //Set false to remove the borders in data table
            dataTable.HasBorders = false;

            //Save and Dispose
            workbook.SaveAs("Chart.xlsx");
            workbook.Close();
        }

HasHorzBorder

True if the data table has inline horizontal border. otherwise False. The default value is True.

Declaration
bool HasHorzBorder { get; set; }
Property Value
Type
System.Boolean
Examples

The following code illustrates how to remove horizontal border for IChartDataTable object.

        using (ExcelEngine excelEngine = new ExcelEngine())
        {
            //Create worksheet
            IApplication application = excelEngine.Excel;
            application.DefaultVersion = ExcelVersion.Excel2013;
            IWorkbook workbook = application.Workbooks.Create(1);
            IWorksheet sheet = workbook.Worksheets[0];

            //Add data
            sheet.Range["A1"].Text = "Jan";
            sheet.Range["B1"].Text = "Feb";
            sheet.Range["C1"].Text = "Mar";
            sheet.Range["A2"].Value = "10";
            sheet.Range["B2"].Value = "20";
            sheet.Range["C2"].Value = "30";
            sheet.Range["A3"].Value = "15";
            sheet.Range["B3"].Value = "25";
            sheet.Range["C3"].Value = "35";

            //Create chart
            IChart chart = sheet.Charts.Add();

            //Set range
            chart.DataRange = sheet.Range["A1:C3"];

            //Set chart type
            chart.ChartType = ExcelChartType.Column_Clustered;

            //Enabling the data table
            chart.HasDataTable = true;

            //Get data table of the chart
            IChartDataTable dataTable = chart.DataTable;

            //Set false to remove the horizontal border in data table
            dataTable.HasHorzBorder = false;

            //Save and Dispose
            workbook.SaveAs("Chart.xlsx");
            workbook.Close();
        }

HasVertBorder

True if the data table has inline vertical border. otherwise False. The default value is True.

Declaration
bool HasVertBorder { get; set; }
Property Value
Type
System.Boolean
Examples

The following code illustrates how to remove vertical border for IChartDataTable object.

        using (ExcelEngine excelEngine = new ExcelEngine())
        {
            //Create worksheet
            IApplication application = excelEngine.Excel;
            application.DefaultVersion = ExcelVersion.Excel2013;
            IWorkbook workbook = application.Workbooks.Create(1);
            IWorksheet sheet = workbook.Worksheets[0];

            //Add data
            sheet.Range["A1"].Text = "Jan";
            sheet.Range["B1"].Text = "Feb";
            sheet.Range["C1"].Text = "Mar";
            sheet.Range["A2"].Value = "10";
            sheet.Range["B2"].Value = "20";
            sheet.Range["C2"].Value = "30";
            sheet.Range["A3"].Value = "15";
            sheet.Range["B3"].Value = "25";
            sheet.Range["C3"].Value = "35";

            //Create chart
            IChart chart = sheet.Charts.Add();

            //Set range
            chart.DataRange = sheet.Range["A1:C3"];

            //Set chart type
            chart.ChartType = ExcelChartType.Column_Clustered;

            //Enabling the data table
            chart.HasDataTable = true;

            //Get data table of the chart
            IChartDataTable dataTable = chart.DataTable;

            //Set false to remove the vertical border in data table
            dataTable.HasVertBorder = false;

            //Save and Dispose
            workbook.SaveAs("Chart.xlsx");
            workbook.Close();
        }

ShowSeriesKeys

True to show series keys in the data table. otherwise False.

Declaration
bool ShowSeriesKeys { get; set; }
Property Value
Type
System.Boolean
Examples

The following code illustrates how to show series keys in the IChartDataTable object.

        using (ExcelEngine excelEngine = new ExcelEngine())
        {
            //Create worksheet
            IApplication application = excelEngine.Excel;
            application.DefaultVersion = ExcelVersion.Excel2013;
            IWorkbook workbook = application.Workbooks.Create(1);
            IWorksheet sheet = workbook.Worksheets[0];

            //Add data
            sheet.Range["A1"].Text = "Jan";
            sheet.Range["B1"].Text = "Feb";
            sheet.Range["C1"].Text = "Mar";
            sheet.Range["A2"].Value = "10";
            sheet.Range["B2"].Value = "20";
            sheet.Range["C2"].Value = "30";
            sheet.Range["A3"].Value = "15";
            sheet.Range["B3"].Value = "25";
            sheet.Range["C3"].Value = "35";

            //Create chart
            IChart chart = sheet.Charts.Add();

            //Set range
            chart.DataRange = sheet.Range["A1:C3"];

            //Set chart type
            chart.ChartType = ExcelChartType.Column_Clustered;

            //Enabling the data table
            chart.HasDataTable = true;

            //Get data table of the chart
            IChartDataTable dataTable = chart.DataTable;

            //Set true to show series keys in the data table
            dataTable.ShowSeriesKeys = true;

            //Save and Dispose
            workbook.SaveAs("Chart.xlsx");
            workbook.Close();
        }

TextArea

Gets the IChartTextArea of the data table. Read-only.

Declaration
IChartTextArea TextArea { get; }
Property Value
Type
IChartTextArea
Examples

The following code illustrates how to get and format the IChartTextArea of the IChartDataTable object.

        using (ExcelEngine excelEngine = new ExcelEngine())
        {
            //Create worksheet
            IApplication application = excelEngine.Excel;
            application.DefaultVersion = ExcelVersion.Excel2013;
            IWorkbook workbook = application.Workbooks.Create(1);
            IWorksheet sheet = workbook.Worksheets[0];

            //Add data
            sheet.Range["A1"].Text = "Jan";
            sheet.Range["B1"].Text = "Feb";
            sheet.Range["C1"].Text = "Mar";
            sheet.Range["A2"].Value = "10";
            sheet.Range["B2"].Value = "20";
            sheet.Range["C2"].Value = "30";
            sheet.Range["A3"].Value = "15";
            sheet.Range["B3"].Value = "25";
            sheet.Range["C3"].Value = "35";

            //Create chart
            IChart chart = sheet.Charts.Add();

            //Set range
            chart.DataRange = sheet.Range["A1:C3"];

            //Set chart type
            chart.ChartType = ExcelChartType.Column_Clustered;

            //Enabling the data table
            chart.HasDataTable = true;

            //Get data table of the chart
            IChartDataTable dataTable = chart.DataTable;

            //Get text area object of the data table
            IChartTextArea textArea = chart.DataTable.TextArea;

            //Set text area font color
            textArea.Color = ExcelKnownColors.BlueCustom;

            //Save and Dispose
            workbook.SaveAs("Chart.xlsx");
            workbook.Close();
        }

Extension Methods