@pioneer-code/pioneer-charts 22.2.19 → 22.2.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
  [![npm](https://img.shields.io/npm/v/@pioneer-code/pioneer-charts)](https://www.npmjs.com/package/@pioneer-code/pioneer-charts)
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6
6
 
7
- Pioneer Charts is an Angular library for building beautiful, customizable, and responsive data visualizations. It leverages [D3.js](https://d3js.org/) for rendering and provides bar, line/area, plot, pie and donut charts, plus a legend component.
7
+ Pioneer Charts is an Angular library for building beautiful, customizable, and responsive data visualizations. It leverages [D3.js](https://d3js.org/) for rendering and provides bar, line/area, plot, pie, donut, dot plot and proximity charts, plus a legend component.
8
8
 
9
9
  ## Documentation
10
10
 
@@ -14,7 +14,7 @@ Guides, the API reference, live examples, and theming instructions all live on t
14
14
 
15
15
  ## Features
16
16
 
17
- - Bar (vertical and horizontal), line, area, plot, pie and donut charts, plus a legend.
17
+ - Bar (vertical and horizontal), line, area, plot, pie, donut, dot plot and proximity charts, plus a legend.
18
18
  - Beautiful default theme, customizable via CSS or by overriding the source Sass variables.
19
19
  - Strongly typed configuration contracts.
20
20
  - Outputs for user interaction (bar, slice, dot, and legend clicks).
@@ -256,6 +256,16 @@ class PcacData {
256
256
  * Optional for the same reason as `image`.
257
257
  */
258
258
  gauge;
259
+ /**
260
+ * The consumer's own identifier for this item - a record's primary key, say. Nothing draws or
261
+ * labels it; it's carried through untouched so a click output (`dotClicked`, `barClicked`,
262
+ * `sliceClicked`, `itemClicked`) can be traced back to the record it came from. Click outputs
263
+ * emit a copy of the item (the chart works on a copy of its config), so matching by object
264
+ * identity doesn't work, and matching by `key` or `image` breaks as soon as two items share one.
265
+ *
266
+ * Optional for the same reason as `image`.
267
+ */
268
+ id;
259
269
  }
260
270
  /**
261
271
  * One side of a `PcacDataRange`. `min` above `max` is read as the other way round; `min` equal to