menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IChartCategory - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Interface IChartCategory

    Represents category in the chart.

    Inherited Members
    IParentApplication.Application
    IParentApplication.Parent
    Namespace: Syncfusion.XlsIO
    Assembly: Syncfusion.XlsIO.UWP.dll
    Syntax
    public interface IChartCategory : IParentApplication

    Properties

    CategoryLabel

    Gets the category label for the chart. Read only.

    Declaration
    IRange CategoryLabel { get; }
    Property Value
    Type
    IRange
    Examples

    The following code illustrates how to access the IChartCategory from IChartCategories object and display its category labels address.

            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 second category
                IChartCategory category = categories[1];           
    
                //Displaying the labels address of the category object
                Console.WriteLine("Category labels address is:" + category.CategoryLabel.AddressLocal);
    
                //Save and Dispose
                workbook.SaveAs("Chart.xlsx");
                workbook.Close();
                Console.ReadKey();
            }

    IsFiltered

    True if the user filters out category. otherwise False.

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

    By default all the categories in the chart are shown because this property is set to "false". Here for example, we filter out first category from the chart and it will not be shown in the chart.

            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 first category 
                IChartCategory category = categories[0];
    
                //Filter out the first category
                category.IsFiltered = true;
    
                //Save and Dispose
                workbook.SaveAs("Chart.xlsx");
                workbook.Close();
            }

    Name

    Gets the category name. Read only.

    Declaration
    string Name { get; }
    Property Value
    Type
    System.String
    Examples

    The following code illustrates how to access the IChartCategory element from IChartCategories object and display its name.

            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();
            }

    Values

    Gets the category values. Read only.

    Declaration
    IRange Values { get; }
    Property Value
    Type
    IRange
    Remarks

    Returns the first series values of the chart category

    Examples

    The following code illustrates how to access the IChartCategory from IChartCategories object and display its value address.

            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 second category
                IChartCategory category = categories[1];           
    
                //Displaying the first series values of the category object
                Console.WriteLine("Category value address is:" + category.Values.AddressLocal);
    
                //Save and Dispose
                workbook.SaveAs("Chart.xlsx");
                workbook.Close();
                Console.ReadKey();
            }

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved