Xceed Workbooks for .NET v3.0 Documentation
Xceed.Workbooks.NET Assembly / Xceed.Workbooks.NET Namespace / CategoryAxis Class
Members Example


In This Topic
    CategoryAxis Class
    In This Topic
    Encapsulates the Category Axis in a Chart.
    Syntax
    'Declaration
     
    
    Public Class CategoryAxis 
       Inherits Axis
    'Usage
     
    
    Dim instance As CategoryAxis
    public class CategoryAxis : Axis 
    Remarks
    This Axis is also known as the x or horizontal Axis.
    Example

    The code below would display the following Chart:

     

    var workbook = Workbook.Create( ChartSample.ChartSampleOutputDirectory + @"AddCharts.xlsx" );
    
    // Gets the first Worksheet. A Workbook always contains at least 1 Worksheet.
    var worksheet = workbook.Worksheets[ 0 ];
    
    // Adds Values for Category.
    worksheet.Cells[ "B4" ].Value = new DateTime( 2020, 1, 1 );
    worksheet.Cells[ "B5" ].Value = new DateTime( 2021, 1, 1 ); ;
    worksheet.Cells[ "B6" ].Value = new DateTime( 2022, 1, 1 );
    worksheet.Cells[ "B7" ].Value = new DateTime( 2023, 1, 1 );
    worksheet.Cells[ "B8" ].Value = new DateTime( 2024, 1, 1 );
    
    // Adds Values for Series.
    worksheet.Cells[ "C4" ].Value = 20;
    worksheet.Cells[ "C5" ].Value = 28;
    worksheet.Cells[ "C6" ].Value = 33;
    worksheet.Cells[ "C7" ].Value = 12;
    worksheet.Cells[ "C8" ].Value = 45;
    
    // Adds a LineChart with the generic Add method and set its SubType. The size of the Chart will be from Cell E4 to L18.
    var lineChart = worksheet.Charts.Add<LineChart>( "E4", "L18" );
    lineChart.SubType = LineChartSubType.LineWithMarkers;
    
    // Sets the Chart's Title.
    lineChart.Title.Text = "Profits";
    lineChart.Title.TextOptions.Font.Bold = true;
    
    // Sets the Legend.
    lineChart.Legend.Position = LegendPositionType.Right;
    
    // Sets the Category data(x values) for the LineChart : Cells B4 to B8.
    lineChart.CategoryData = CategoryData.FromCells( worksheet, "B4", "B8" );
    
    // Adds LineSeries to the LineChart (y values) by specifying fixed values and a Range of Cells’ Adresses.
    var lineSeries1 = lineChart.SeriesCollection.AddFromValues<LineSeries>( 5, 10, 15, 20, 40 );
    lineSeries1.Name = "IBM";
    var lineSeries2 = lineChart.SeriesCollection.AddFromCells<LineSeries>( "C4", "C8" );
    lineSeries2.Name = "Apple";
    
    // Customizes the Category & Value Axis Line.
    lineChart.ValueAxis.Line.Color = Xceed.Drawing.Color.Blue;
    lineChart.CategoryAxis.Line.Color = Xceed.Drawing.Color.Red;
    lineChart.CategoryAxis.Line.Width = 3d;
    
    // Sets the minimum and maximum value for the CategoryAxis.
    lineChart.CategoryAxis.Minimum = new DateTime( 2020, 1, 1 );
    lineChart.CategoryAxis.Maximum = new DateTime( 2023, 1, 1 );
    
    // Sets where the ValueAxis will cross the CategoryAxis.
    lineChart.CategoryAxis.CrossPositionType = CrossPositionType.Custom;
    lineChart.CategoryAxis.CrossPositionCustomValue = new DateTime( 2021, 1, 1 );
    
    // Shows the Major Tickmarks on the CategoryAxis.
    lineChart.CategoryAxis.MajorTickMarksType = TickMarksType.Cross;
    
    // Sets the position of the CategoryAxis’ labels on the TickMarks.
    lineChart.CategoryAxis.IsBetweenTickMarks = false;
    
    // Customizes & formats the CategoryAxis’ labels to display only the years.
    lineChart.CategoryAxis.TickLabelsDistanceFromAxis = 500;
    lineChart.CategoryAxis.TickLabels.TextFill.Color = Xceed.Drawing.Color.Red;
    lineChart.CategoryAxis.TickLabels.CustomFormat = "yyyy";        
    
    // Sets and customizes the CategoryAxis’ Title.
    lineChart.CategoryAxis.Title.IsVisible = true;
    lineChart.CategoryAxis.Title.Text = "Years";
    lineChart.CategoryAxis.Title.TextOptions.TextFill.Color = Xceed.Drawing.Color.Red;
    lineChart.CategoryAxis.Title.TextOptions.Font.Size = 15;
    lineChart.CategoryAxis.Title.TextOptions.Font.Bold = true;
    
    // Saves Workbook to disk.
    workbook.Save();
    Inheritance Hierarchy

    System.Object
       Xceed.Workbooks.NET.Axis
          Xceed.Workbooks.NET.CategoryAxis

    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also