Interface IChartCategories

Represents a collection of chart categories.

Inherited Members

IParentApplication.Application

IParentApplication.Parent

Namespace: Syncfusion.XlsIO

Assembly: Syncfusion.XlsIO.Portable.dll

Syntax

public interface IChartCategories : IParentApplication, ICollection<IChartCategory>, IEnumerable<IChartCategory>, IEnumerable

Properties

Count

Gets the number of elements in the collection. Read-only.

Declaration

int Count { get; }

Property Value

Type	Description
System.Int32

Examples

The following code illustrates how to get number of IChartCategory elements in the IChartCategories 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;

            //Get chart categories collection
            IChartCategories categories = chart.Categories;   

            //Displaying the number of categories in the chart
            Console.WriteLine("Number of categories in the chart is:" + categories.Count.ToString());

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

Item[Int32]

Gets a single category object with the specified index.

Declaration

IChartCategory this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type	Description
IChartCategory

Examples

The following code illustrates how to access the IChartCategory element by index from the IChartCategories 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;

            //Get chart categories collection
            IChartCategories categories = chart.Categories;   

            //Get chart category by index
            IChartCategory category = categories[1];           

            //Displaying the name of the category object
            Console.WriteLine("Name of the second category is:" + category.Name);

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

Item[String]

Gets a single category object with the specified name.

Declaration

IChartCategory this[string name] { get; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type	Description
IChartCategory

Examples

The following code illustrates how to access the IChartCategory element by name from the IChartCategories 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;

            //Get chart categories collection
            IChartCategories categories = chart.Categories;   

            //Get chart category by name
            IChartCategory category = categories["Jan"];       

            //Checking whether the category is filtered
            Console.WriteLine("Is Jan category is filtered:" + category.IsFiltered);

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