ChartDataPoint class

ChartDataPoint class

Allows to specify formatting of a single data point on the chart. To learn more, visit the Working with Charts documentation article.

Remarks

On a series, the ChartDataPoint object is a member of the ChartDataPointCollection. The ChartDataPointCollection contains a ChartDataPoint object for each point.

Properties

NameDescription
bubble3DSpecifies whether the bubbles in Bubble chart should have a 3-D effect applied to them.
explosionSpecifies the amount the data point shall be moved from the center of the pie. Can be negative, negative means that property is not set and no explosion should be applied. Applies only to Pie charts.
formatProvides access to fill and line formatting of this data point.
indexIndex of the data point this object applies formatting to.
invertIfNegativeSpecifies whether the parent element shall inverts its colors if the value is negative.
markerSpecifies chart data marker.

Methods

NameDescription
clearFormat()Clears format of this data point. The properties are set to the default values defined in the parent series.

Examples

Shows how to work with data points on a line chart.

test('ChartDataPoint', () => {
  let doc = new aw.Document();
  let builder = new aw.DocumentBuilder(doc);

  let shape = builder.insertChart(aw.Drawing.Charts.ChartType.Line, 500, 350);
  let chart = shape.chart;

  expect(chart.series.count).toEqual(3);
  expect(chart.series.at(0).name).toEqual("Series 1");
  expect(chart.series.at(1).name).toEqual("Series 2");
  expect(chart.series.at(2).name).toEqual("Series 3");

  // Emphasize the chart's data points by making them appear as diamond shapes.
  for (let series of chart.series)
    applyDataPoints(series, 4, aw.Drawing.Charts.MarkerSymbol.Diamond, 15);

  // Smooth out the line that represents the first data series.
  chart.series.at(0).smooth = true;

  // Verify that data points for the first series will not invert their colors if the value is negative.
  for (let p of chart.series.at(0).dataPoints)
  {
    expect(p.invertIfNegative).toEqual(false);
  }

  let dataPoint = chart.series.at(1).dataPoints.at(2);
  dataPoint.format.fill.color = "#FF0000";

  // For a cleaner looking graph, we can clear format individually.
  dataPoint.clearFormat();

  // We can also strip an entire series of data points at once.
  chart.series.at(2).dataPoints.clearFormat();

  doc.save(base.artifactsDir + "Charts.ChartDataPoint.docx");
});

See Also