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


In This Topic
    ScatterSeries Class
    In This Topic
    Encapsulates Series of the Scatter type.
    Syntax
    'Declaration
     
    
    Public Class ScatterSeries 
       Inherits Series
    'Usage
     
    
    Dim instance As ScatterSeries
    public class ScatterSeries : Series 
    Remarks
    This is usually used in ScatterCharts.
    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;
    
    // Adds a ScatterChart with the generic Add method and sets its subType. The size of the Chart will be from Cell E4 to L18.
    var scatterChart = worksheet.Charts.Add<ScatterChart>( "E4", "L18" );
    scatterChart.SubType = ScatterChartSubType.Scatter;
    
    // Sets the Chart's Title.
    scatterChart.Title.Text = "Profits";
    scatterChart.Title.TextOptions.Font.Bold = true;
    
    // Sets the Legend.
    scatterChart.Legend.Position = LegendPositionType.Right;
    
    // Sets the Category data(x values) for the ScatterChart : Cells B4 to B8.
    scatterChart.CategoryData = CategoryData.FromCells( worksheet, "B4", "B8" );
    
    scatterChart.PlotArea.Fill.Color = Xceed.Drawing.Color.LightGray;
    
    // Adds ScatterSeries to the ScatterChart (y values) by specifying fixed values and a range of Cells’ Adresses.
    var scatterSeries1 = scatterChart.SeriesCollection.AddFromValues<ScatterSeries>( 5, 5, 25, 20, 40 );
    scatterSeries1.Name = "IBM";
    var scatterSeries2 = scatterChart.SeriesCollection.AddFromCells<ScatterSeries>( "C4", "C8" );
    scatterSeries2.Name = "Apple";
    
    // Customizes the size of the Series’ Markers.
    scatterSeries1.Marker.Size = 8;
    scatterSeries2.Marker.Size = 8;
    
    // Shows the value and categoryName, with a custom separator, in the DataPoint labels and displays it at the right of the markers.
    scatterSeries1.DataPointLabels.ShowValue = true;
    scatterSeries1.DataPointLabels.ShowCategoryName = true;
    scatterSeries1.DataPointLabels.SeparatorType = DataPointLabelsSeparatorType.Custom;
    scatterSeries1.DataPointLabels.SeparatorCustom = "-";
    scatterSeries1.DataPointLabels.Position = PointDataPointLabelsPositionType.Right;
    scatterSeries2.DataPointLabels.ShowValue = true;
    scatterSeries2.DataPointLabels.ShowCategoryName = true;
    scatterSeries2.DataPointLabels.SeparatorType = DataPointLabelsSeparatorType.Custom;
    scatterSeries2.DataPointLabels.SeparatorCustom = "-";
    scatterSeries2.DataPointLabels.Position = PointDataPointLabelsPositionType.Right;
    
    // Saves Workbook to disk.
    workbook.Save();
    Inheritance Hierarchy

    System.Object
       Xceed.Workbooks.NET.WorkbookElement
          Xceed.Workbooks.NET.WorksheetElement
             Xceed.Workbooks.NET.ChartValueRange
                Xceed.Workbooks.NET.Series
                   Xceed.Workbooks.NET.ScatterSeries

    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