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


In This Topic
    StockChart Class
    In This Topic
    Encapsulates a Chart of the Stock type in a Worksheet.
    Syntax
    'Declaration
     
    
    Public Class StockChart 
       Inherits Chart
    'Usage
     
    
    Dim instance As StockChart
    public class StockChart : Chart 
    Remarks
    A minimum of 3 StockSeries is necessary in order to use this type of Chart.
    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 = 2020;
    worksheet.Cells[ "B5" ].Value = 2021;
    worksheet.Cells[ "B6" ].Value = 2022;
    worksheet.Cells[ "B7" ].Value = 2023;
    worksheet.Cells[ "B8" ].Value = 2024;
    
    // 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;
    worksheet.Cells[ "D4" ].Value = 7;
    worksheet.Cells[ "D5" ].Value = 33;
    worksheet.Cells[ "D6" ].Value = 15;
    worksheet.Cells[ "D7" ].Value = 35;
    worksheet.Cells[ "D8" ].Value = 25;
    
    // Adds a StockChart with the generic Add method and set its SubType. The size of the Chart will be from Cell E4 to L18.
    var stockChart = worksheet.Charts.Add<StockChart>( "E4", "L18" );
    stockChart.SubType = StockChartSubType.OpenHighLowClose;
    
    // Sets the Chart's Title.
    stockChart.Title.Text = "Profits";
    stockChart.Title.TextOptions.Font.Bold = true;
    
    // Sets the Category data(x values) for the StockChart : Cells B4 to B8.
    stockChart.CategoryData = CategoryData.FromCells( worksheet, "B4", "B8" );
    
    // Adds StockSeries to the StockChart (y values) by specifying fixed values, a Range of Cells’ Adresses and a Range of Cells’ Row & Column ids.
    var stockSeriesOpen = stockChart.SeriesCollection.AddFromValues<StockSeries>( 5, 10, 15, 20, 40 );
    var scatterSeriesHigh = stockChart.SeriesCollection.AddFromCells<StockSeries>( "C4", "C8" );
    var scatterSeriesLow = stockChart.SeriesCollection.AddFromCells<StockSeries>( 3, 3, 7, 3 );
    var stockSeriesClose = stockChart.SeriesCollection.AddFromValues<StockSeries>( 13, 22, 17, 10, 20 );
    
    // Saves Workbook to disk.
    workbook.Save();
    Inheritance Hierarchy

    System.Object
       Xceed.Workbooks.NET.WorkbookElement
          Xceed.Workbooks.NET.WorksheetElement
             Xceed.Workbooks.NET.PositionedElement
                Xceed.Workbooks.NET.Chart
                   Xceed.Workbooks.NET.StockChart

    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