Represents the a specific data point in a [[series]].

This class encapsulates an individual point of data in a [[series]].

A data point manifests differently depending on the chart type; for example, on a bar chart it represents the bar itself, and for a line chart, it represents a point on the line. For pie and doughnut charts, a data point represents a slice or wedge in the pie/doughnut.

Many of the properties exposed by this class are also found on the [[series]] class; setting the property on the series affects all points on the series, whereas setting a property on this class affects only one individual point in the series.

In cases where most of the data points share the same property values, use the property of the Series class, overriding the property values for any individual points using this class.

See

  • [[series]]
  • [[Series.explosion]]
  • [[Series.markerStyle]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get applyPicToEnd(): boolean
  • Returns or sets a value indicating whether a picture is applied to the end of the point or all points in the series.

    Returns boolean

  • set applyPicToEnd(a): void
  • Parameters

    • a: boolean

    Returns void

  • get applyPicToFront(): boolean
  • Returns or sets a value indicating whether a picture is applied to the front of the point or all points in the series.

    Returns boolean

  • set applyPicToFront(a): void
  • Parameters

    • a: boolean

    Returns void

  • get applyPicToSides(): boolean
  • Returns or sets a value indicating whether a picture is applied to the sides of the point or all points in the series.

    Returns boolean

  • set applyPicToSides(a): void
  • Parameters

    • a: boolean

    Returns void

  • get border(): ChartBorder
  • Determines the appearance of the border drawn around the data point's [[fill]] area.

    For series which support fills, this property controls the color and size of the line drawn around the data point's fill region.

    See

    [[fill]]

    Returns ChartBorder

  • set border(a): void
  • Parameters

    Returns void

  • get chart(): WorksheetChart
  • Returns the owning chart (read-only)

    See

    [[owner]]

    Returns WorksheetChart

  • get dataLabel(): DataLabel
  • Returns or sets a [[dataLabel]] instance which defines the properties of the label displayed for this data point.

    In order to display data labels, the [[Series.showDataLabels]] property must be set to true.

    Use the [[Series.dataLabels]] property to apply property settings to all data labels in the series.

    Use the [[DataLabel.isDeleted]] property to hide the label for a specific data point.

    See

    • [[Series.showDataLabels]]
    • [[Series.dataLabels]]

    Returns DataLabel

  • set dataLabel(a): void
  • Parameters

    Returns void

  • get explosion(): number
  • Returns or sets the explosion value for a pie-chart or doughnut-chart slice.

    In the context of a pie or doughnut chart, a [[DataPoint]] is synonymous with an individual slice of the pie/doughnut.

    Explosion refers to the amount by which a slice in the pie is offset from the center point of the circle.

    The valid range of values is between 0 and 400, inclusive.

    Use the [[Series.explosion]] property to set the explosion for all slices in the pie.

    See

    [[Series.explosion]]

    Throws

    [[ArgumentOutOfRangeException]] The value is outside the range of 0 and 400.

    Returns number

  • set explosion(a): void
  • Parameters

    • a: number

    Returns void

  • get fill(): ChartFillBase
  • Returns or sets a [[ChartFillBase]] derived object which defines the fill properties for the data point.

    This property returns null by default, indicating that no fill is applied. In this case, the default fill color for the associated [[series]] is used.

    To apply a solid color fill, assign an instance of the [[ChartSolidFill]] class to this property.

    To apply a gradient fill, assign an instance of the [[ChartGradientFill]] class to this property.

    See

    • [[ChartSolidFill]]
    • [[ChartGradientFill]]

    Returns ChartFillBase

  • set fill(a): void
  • Parameters

    Returns void

  • get invertIfNegative(): boolean
  • Returns or sets a value indicating whether the pattern is inverted in the item when it corresponds to a negative number.

    Returns boolean

  • set invertIfNegative(a): void
  • Parameters

    • a: boolean

    Returns void

  • get markerBorder(): ChartBorder
  • Determines the appearance of the border (a.k.a. outline) of the marker for this data point.

    This property provides a way to customize the marker border for an individual data point in the series.

    A value of null implies that the marker border is not explicitly set on this data point, and should inherit the value from it's associated [[series]].

    Use the [[Series.markerBorder]] property to customize the border for all markers in the series.

    See

    [[Series.markerBorder]]

    Returns ChartBorder

  • set markerBorder(a): void
  • Parameters

    Returns void

  • get markerFill(): ChartFillBase
  • Defines the fill appearance of the marker for this data point.

    This property provides a way to customize the marker fill color for an individual data point in the series.

    A value of null implies that the marker fill color is not explicitly set on this data point, and should inherit the value from it's associated [[series]].

    Use the [[Series.markerFill]] property to customize the fill color for all markers in the series.

    See

    [[Series.markerFill]]

    Returns ChartFillBase

  • set markerFill(a): void
  • Parameters

    Returns void

  • get markerSize(): number
  • Determines the size of the marker for this data point.

    This property provides a way to customize the marker size for an individual data point in the series.

    A value of null implies that the marker size is not explicitly set on this data point, and should inherit the value from it's associated [[series]].

    Use the [[Series.markerSize]] property to customize the size of all markers in the series.

    See

    [[Series.markerSize]]

    Returns number

  • set markerSize(a): void
  • Parameters

    • a: number

    Returns void

  • get markerStyle(): MarkerStyle
  • Determines the style of the marker for this data point.

    This property provides a way to customize the marker style for an individual data point in the series.

    A value of null implies that the marker style is not explicitly set on this data point, and should inherit the value from it's associated [[series]].

    Use the [[Series.markerStyle]] property to customize the style of all markers in the series.

    See

    [[Series.markerStyle]]

    Returns MarkerStyle

  • set markerStyle(a): void
  • Parameters

    Returns void

  • get owner(): ChartObject
  • returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

    See

    [[chart]]

    Returns ChartObject

  • get setAsTotal(): boolean
  • Returns or sets a boolean value indicating whether this data point represents a total or subtotal in a waterfall chart.

    This property is only applicable for waterfall charts.

    See

    [[Series.showWaterfallConnectorLines]]

    Returns boolean

  • set setAsTotal(a): void
  • Parameters

    • a: boolean

    Returns void

  • get sheet(): Sheet
  • The owning sheet (read-only)

    Returns Sheet

  • get workbook(): Workbook
  • The owning workbook (read-only)

    Returns Workbook

  • get worksheet(): Worksheet
  • The owning worksheet (read-only)

    Returns Worksheet

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Returns Base

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Returns void