@pacem/pacem-charts 1.0.0-bessel → 1.0.0-binet

package/dist/browser/pacem-charts.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-binet (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -117,11 +117,15 @@
         }
         return gcd(b % a, a);
     }
+    /** Custom UI event dispatched by chart elements when the user interacts with a rendered data point (e.g. `itemclick`, `itemmouseover`). */
     class ChartEvent extends pacemCore.CustomUIEvent {
         constructor(type, eventInit, originalEvent) {
             super(type, eventInit, originalEvent);
         }
     }
+    /**
+     * Represents a single data series to be plotted within a `<pacem-chart>`-like element.
+     */
     let PacemChartSeriesElement = class PacemChartSeriesElement extends pacemCore.Components.PacemItemElement {
         get values() {
             return this.datasource;
@@ -146,6 +150,10 @@
         pacemCore.CustomElement({ tagName: pacemCore.P + '-chart-series' })
     ], PacemChartSeriesElement);
     const SVG_NS$2 = "http://www.w3.org/2000/svg";
+    /**
+     * Abstract base class for chart elements hosting a collection of {@link PacemChartSeriesElement} items.
+     * Provides axis/grid computation and SVG drawing helpers shared by concrete chart-series elements (e.g. `PacemChartElement`, `PacemColumnChartElement`).
+     */
     class PacemSeriesChartElement extends pacemCore.Components.PacemItemsContainerElement {
         constructor() {
             super();
@@ -548,6 +556,9 @@
     const PADDING_PIXELS$1 = 24;
     const SERIES_MAGNITUDE = 'pacem:chart-series:area';
     const SVG_NS$1 = "http://www.w3.org/2000/svg";
+    /**
+     * Renders a line, spline, area or spline-area chart out of one or more {@link PacemChartSeriesElement} series.
+     */
     let PacemChartElement = class PacemChartElement extends PacemSeriesChartElement {
         constructor() {
             super(...arguments);
@@ -952,6 +963,9 @@
     //namespace Pacem.Components.Charts {
     const SVG_NS = "http://www.w3.org/2000/svg";
     const PADDING_PIXELS = 24;
+    /**
+     * Renders a clustered or stacked column (bar) chart out of one or more {@link PacemChartSeriesElement} series.
+     */
     let PacemColumnChartElement = class PacemColumnChartElement extends PacemSeriesChartElement {
         constructor() {
             super(...arguments);
@@ -1304,6 +1318,9 @@
         return c > 3 && r && Object.defineProperty(target, key, r), r;
     };
     //namespace Pacem.Components.Charts {
+    /**
+     * Represents a single slice within a `<pacem-pie-chart>`.
+     */
     let PacemPieSliceElement = class PacemPieSliceElement extends pacemCore.Components.PacemItemElement {
         constructor() {
             super(...arguments);
@@ -1368,6 +1385,9 @@
     ], PacemPieSliceElement);
     const TWO_PI = Math.PI * 2;
     const PI1_2 = Math.PI * .5;
+    /**
+     * Renders a pie or doughnut chart out of one or more {@link PacemPieSliceElement} slices.
+     */
     let PacemPieChartElement = class PacemPieChartElement extends pacemCore.Components.PacemItemsContainerElement {
         constructor() {
             super();