GemBox.Spreadsheet
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    ScatterChart Class

    Namespace:
    GemBox.Spreadsheet.Charts
    Assembly:
    GemBox.Spreadsheet.dll

    Represents a chart whose series values are drawn using horizontal rectangles.

    • C#
    • VB.NET
    public sealed class ScatterChart : ExcelChart
    Public NotInheritable Class ScatterChart
        Inherits ExcelChart
    Inheritance:
    System.Object
    ExcelDrawing
    ExcelChart
    ScatterChart

    Properties

    Axes

    Gets the chart axes.

    • C#
    • VB.NET
    public ChartAxes Axes { get; }
    Public ReadOnly Property Axes As ChartAxes
    Property Value
    ChartAxes

    The chart axes.

    CategoryLabels

    Gets the chart's category labels.

    • C#
    • VB.NET
    public override IEnumerable<string> CategoryLabels { get; }
    Public Overrides ReadOnly Property CategoryLabels As IEnumerable(Of String)
    Property Value
    System.Collections.Generic.IEnumerable<System.String>

    The chart's category labels.

    Overrides
    ExcelChart.CategoryLabels
    Remarks

    Method will always return an empty collection since scatter chart doesn't support category labels.

    CategoryLabelsReference

    Scatter chart doesn't support category labels. Please use ScatterChartSeries to set x or y values.

    • C#
    • VB.NET
    public override string CategoryLabelsReference { get; set; }
    Public Overrides Property CategoryLabelsReference As String
    Property Value
    System.String

    The scatter chart's category labels which is always null.

    Overrides
    ExcelChart.CategoryLabelsReference

    ChartType

    Gets the chart type for ScatterChart which is Scatter.

    • C#
    • VB.NET
    public override ChartType ChartType { get; }
    Public Overrides ReadOnly Property ChartType As ChartType
    Property Value
    ChartType

    The Scatter value.

    Overrides
    ExcelChart.ChartType

    Series

    Gets the chart's series.

    • C#
    • VB.NET
    public ScatterChartSeriesCollection Series { get; }
    Public ReadOnly Property Series As ScatterChartSeriesCollection
    Property Value
    ScatterChartSeriesCollection

    The chart's series.

    ShowMarkers

    Gets or sets a value indicating whether markers will be shown on series points.

    Value is resolved from the series. If any series has a marker than all newly added series will also have a marker.

    When setting a value, value is propagated to all series.

    • C#
    • VB.NET
    public bool ShowMarkers { get; set; }
    Public Property ShowMarkers As Boolean
    Property Value
    System.Boolean

    true if markers will be shown on series points; otherwise, false.

    SmoothLines

    Gets or sets a value indicating whether the series lines will be smooth or straight.

    • C#
    • VB.NET
    public bool SmoothLines { get; set; }
    Public Property SmoothLines As Boolean
    Property Value
    System.Boolean

    true if series lines will be smooth; otherwise, false.

    Methods

    SetCategoryLabels(IEnumerable<String>)

    Scatter chart doesn't support category labels. Please use ScatterChartSeries to set x or y values.

    • C#
    • VB.NET
    public override void SetCategoryLabels(IEnumerable<string> categoryLabels)
    Public Overrides Sub SetCategoryLabels(categoryLabels As IEnumerable(Of String))
    Parameters
    categoryLabels
    System.Collections.Generic.IEnumerable<System.String>

    The chart's category labels.

    Overrides
    ExcelChart.SetCategoryLabels(IEnumerable<String>)
    Exceptions
    System.NotSupportedException

    Scatter chart doesn't support category labels.

    Inherited Properties

    DataLabels

    Gets the settings for the data labels for the entire chart.

    (Inherited from ExcelChart)

    Fill

    Gets or sets the fill formatting options.

    (Inherited from ExcelChart)

    Hyperlink

    Gets or sets the hyperlink on this drawing (picture, chart, etc.).

    (Inherited from ExcelDrawing)

    Legend

    Gets the chart's legend.

    (Inherited from ExcelChart)

    Metadata

    Gets the metadata (non-visual properties) of this ExcelDrawing instance.

    (Inherited from ExcelDrawing)

    Outline

    Gets or sets the outline formatting options.

    (Inherited from ExcelChart)

    PlotArea

    Gets the chart's plot area.

    (Inherited from ExcelChart)

    Position

    Gets the position of this drawing (picture, chart, etc.) in the worksheet.

    (Inherited from ExcelDrawing)

    RoundedCorners

    Gets or sets a value indicating whether the chart area border has rounded corners.

    Default value is false.

    (Inherited from ExcelChart)

    ShowDataInHiddenCells

    Gets or sets the value which indicates whether only visible cells should be plotted on the chart.

    (Inherited from ExcelChart)

    ShowEmptyCellsAs

    Gets or sets the value which indicates how empty cells (cells with Value equal to null) shall be plotted on the chart.

    (Inherited from ExcelChart)

    TextFormat

    Gets or sets the text formatting options.

    (Inherited from ExcelChart)

    Title

    Gets the chart's title.

    (Inherited from ExcelChart)

    UseSecondaryAxis

    Gets or sets the value which indicates whether this chart should use the secondary axis of parent ComboChart.

    (Inherited from ExcelChart)

    Worksheet

    Gets the parent worksheet.

    (Inherited from ExcelDrawing)

    ZIndex

    Gets the z-order position of the picture. -1 if the picture is not contained in proper collection.

    (Inherited from ExcelDrawing)

    Inherited Methods

    BringForward()

    Moves the chart one position forward in the drawings if the parent collection is ExcelChartCollection.

    (Inherited from ExcelChart)

    BringToFront()

    Brings the chart to the front of the drawings if the parent collection is ExcelChartCollection.

    (Inherited from ExcelChart)

    ChangeChartType(ChartType)

    Changes the chart to a different type of chart.

    (Inherited from ExcelChart)

    ChangeChartType<TChart>()

    Changes the chart to a different type of chart.

    (Inherited from ExcelChart)

    Format()

    Formats this drawing (picture, chart, etc.) to its default size so it can be exported to PDF, XPS, image or be printed.

    (Inherited from ExcelDrawing)

    Format(System.Double, System.Double, LengthUnit)

    Formats this drawing (picture, chart, etc.) to specified size so it can be exported to PDF, XPS, image or be printed.

    (Inherited from ExcelDrawing)

    MoveZIndex(System.Int32)

    Moves the picture forward or backward in the drawings with the given relative index if the parent collection is ExcelChartCollection.

    (Inherited from ExcelChart)

    SelectData(CellRange)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(CellRange, System.Boolean)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(CellRange, System.Boolean, System.Boolean)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(CellRange, System.Boolean, System.Boolean, System.Boolean)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(System.String)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(System.String, System.Boolean)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(System.String, System.Boolean, System.Boolean)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SelectData(System.String, System.Boolean, System.Boolean, System.Boolean)

    Selects the data for the chart.

    (Inherited from ExcelChart)

    SendBackward()

    Moves the chart one position backward in the drawings if the parent collection is ExcelChartCollection.

    (Inherited from ExcelChart)

    SendToBack()

    Sends the chart to the back of the drawings if the parent collection is ExcelChartCollection.

    (Inherited from ExcelChart)

    SetCategoryLabels(System.String[])

    Sets the chart's category labels.

    (Inherited from ExcelChart)

    ToString()

    Returns a System.String that represents this ExcelChart instance.

    (Inherited from ExcelChart)

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.