Interface IChartInterior

Represents the chart interior. Interior of chart is supported in Chart area and Plot area only.

Namespace: Syncfusion.XlsIO

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public interface IChartInterior

Properties

BackgroundColor

Gets or sets the background color of the chart. Background color values are from System.Drawing.Color.

Declaration

Color BackgroundColor { get; set; }

Property Value

Type
System.Drawing.Color

Remarks

Background color can be visible only if the Interior Pattern is enable. To know more about charts refer this link.

Examples

The following code illustrates the use of BackgroundColor property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //sets the backgroundColor color of the chart
        chart.ChartArea.Interior.BackgroundColor = System.Drawing.Color.Red;
        chart.ChartArea.Interior.Pattern = ExcelPattern.Angle;

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

BackgroundColorIndex

Gets or sets the index of background color in ExcelKnownColors.

Declaration

ExcelKnownColors BackgroundColorIndex { get; set; }

Property Value

Type
ExcelKnownColors

Remarks

Background color index can be visible only if the Interior Pattern is enable. To know more about charts refer this link.

Examples

The following code illustrates the use of BackgroundColorIndex property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //sets the backgroundColor color of the chart
        chart.ChartArea.Interior.BackgroundColorIndex = ExcelKnownColors.Bright_green;
        chart.ChartArea.Interior.Pattern = ExcelPattern.Angle;

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

ForegroundColor

Gets or sets the foreground color of the chart. Foreground color values are from System.Drawing.Color.

Declaration

Color ForegroundColor { get; set; }

Property Value

Type
System.Drawing.Color

Remarks

To know more about charts refer this link.

Examples

The following code illustrates the use of ForegroundColor property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //sets the foreground color of the chart
        chart.ChartArea.Interior.ForegroundColor = System.Drawing.Color.AliceBlue;

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

ForegroundColorIndex

Gets or sets the index of foreground color in ExcelKnownColors.

Declaration

ExcelKnownColors ForegroundColorIndex { get; set; }

Property Value

Type
ExcelKnownColors

Remarks

To know more about charts refer this link.

Examples

The following code illustrates the use of ForegroundColorIndex property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //sets the index of foreground color
        chart.ChartArea.Interior.ForegroundColorIndex = ExcelKnownColors.Aqua;

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

Pattern

Gets or sets the area pattern. Pattern property values are from ExcelPattern.

Declaration

ExcelPattern Pattern { get; set; }

Property Value

Type
ExcelPattern

Remarks

To know more about charts refer this link.

Examples

The following code illustrates the use of Pattern property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //sets the pattern of the chart
        chart.ChartArea.Interior.Pattern = ExcelPattern.Angle;

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }

SwapColorsOnNegative

True if foreground and background colors are swapped when the data value is negative. otherwise False.

Declaration

bool SwapColorsOnNegative { get; set; }

Property Value

Type
System.Boolean

Remarks

The SwapColorsOnNegative property works on Binary Excel format only. To know more about charts refer this link.

Examples

The following code illustrates the use of SwapColorsOnNegative property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = -92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = -55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];
        chart.IsSeriesInRows = false;

        //True if foreground and background colors are swapped when the data value is negative
        chart.Series[0].SerieFormat.Interior.SwapColorsOnNegative = true;

        workbook.SaveAs("Charts.xls");
        workbook.Close();
      }

UseAutomaticFormat

True to use automatic format. False to use custom format.

Declaration

bool UseAutomaticFormat { get; set; }

Property Value

Type
System.Boolean

Remarks

To know more about charts refer this link.

Examples

The following code illustrates the use of UseAutomaticFormat property.

      using (ExcelEngine excelEngine = new ExcelEngine())
      {
        //Create a worksheet.        
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet sheet = workbook.Worksheets[0];
        sheet.Range["A1"].Text = "Student ID";
        sheet.Range["B1"].Text = "Student Name";
        sheet.Range["C1"].Text = "Mark(Out of 100)";
        sheet.Range["A1:C1"].AutofitColumns();
        sheet.Range["A2"].Number = 1;
        sheet.Range["A3"].Number = 2;
        sheet.Range["A4"].Number = 3;
        sheet.Range["A5"].Number = 4;
        sheet.Range["A6"].Number = 5;
        sheet.Range["B2"].Text = "Andrew";
        sheet.Range["B3"].Text = "Marson";
        sheet.Range["B4"].Text = "Jack";
        sheet.Range["B5"].Text = "Sam";
        sheet.Range["B6"].Text = "Breto";
        sheet.Range["C2"].Number = 77;
        sheet.Range["C3"].Number = 45;
        sheet.Range["C4"].Number = 92;
        sheet.Range["C5"].Number = 39;
        sheet.Range["C6"].Number = 55;

        //Create a Chart
        IChartShape chart = sheet.Charts.Add();
        chart.LeftColumn = 5;
        chart.RightColumn = 11;
        chart.Name = "Student Sample Chart";
        chart.ChartType = ExcelChartType.Cone_Clustered_3D;
        chart.DataRange = sheet.Range["B2:C6"];

        //True to use automatic format for interior
        chart.ChartArea.Interior.UseAutomaticFormat = true;

        workbook.SaveAs("Charts.xlsx");
        workbook.Close();
      }