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

package/dist/esm/column.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -14,6 +14,9 @@ import { PacemSeriesChartElement } from './types';
 //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);

package/dist/esm/generic.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -45,6 +45,9 @@ const DEL_VAL = CustomElementUtils.deleteAttachedPropertyValue;
 const PADDING_PIXELS = 24;
 const SERIES_MAGNITUDE = 'pacem:chart-series:area';
 const SVG_NS = "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);

package/dist/esm/index-components-charts.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index-components.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index-iife.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */

package/dist/esm/pie.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -12,6 +12,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { CustomElement, Watch, PropertyConverters, P, PCSS, Components, Utils, CustomElementUtils, Debounce } from '@pacem/pacem-core';
 import { MANAGED_EVENTS } from './types';
 //namespace Pacem.Components.Charts {
+/**
+ * Represents a single slice within a `<pacem-pie-chart>`.
+ */
 let PacemPieSliceElement = class PacemPieSliceElement extends Components.PacemItemElement {
     constructor() {
         super(...arguments);
@@ -77,6 +80,9 @@ PacemPieSliceElement = __decorate([
 export { 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 Components.PacemItemsContainerElement {
     constructor() {
         super();

package/dist/esm/types.js

@@ -1,5 +1,5 @@
 /*!
- * @pacem/pacem-charts v1.0.0-bessel (https://js.pacem.it)
+ * @pacem/pacem-charts v1.0.0-dirac (https://js.pacem.it)
  * Pacem (https://pacem.it)
  * Licensed under Apache-2.0
  */
@@ -116,11 +116,15 @@ function gcd(a, b) {
     }
     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`). */
 export class ChartEvent extends 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 Components.PacemItemElement {
     get values() {
         return this.datasource;
@@ -146,6 +150,10 @@ PacemChartSeriesElement = __decorate([
 ], PacemChartSeriesElement);
 export { PacemChartSeriesElement };
 const SVG_NS = "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`).
+ */
 export class PacemSeriesChartElement extends Components.PacemItemsContainerElement {
     constructor() {
         super();

package/package.json

@@ -4,6 +4,7 @@
     "dist/browser/*.*",
     "dist/bundle/*.*",
     "dist/esm/*.*",
+    "dist/docs/*.*",
     "typings/*.*",
     "README.md",
     "LICENSE",
@@ -24,7 +25,7 @@
       "types": "./typings/index.d.ts"
     }
   },
-  "version": "1.0.0-bessel",
+  "version": "1.0.0-dirac",
   "author": {
     "name": "Pacem",
     "url": "https://pacem.it"

package/typings/index.d.ts

@@ -3,19 +3,27 @@ import { CustomUIEvent } from '@pacem/pacem-core';
 import { Point } from '@pacem/pacem-foundation';
 import { Size } from '@pacem/pacem-foundation';
 
+/** A single labeled value belonging to a {@link ChartDataSeries}. */
 declare interface ChartDataItem {
     label: any;
     value: number;
 }
 
+/** A named collection of {@link ChartDataItem}s to be plotted on a chart. */
 declare interface ChartDataSeries {
+    /** Gets the (already sorted) set of chart data items. */
     readonly values: ChartDataItem[];
+    /** Gets the series label. */
     readonly label: any;
+    /** Gets the series color. */
     readonly color?: string;
+    /** Gets the CSS class(es) to apply to the series' rendered elements. */
     readonly className?: string;
+    /** Gets a value indicating whether the single data points should be rendered too. */
     readonly datapoints?: boolean;
 }
 
+/** Flattened representation of a single data point along with its owning series' label and color, used as the payload of {@link ChartEventArgs}. */
 declare type ChartDataSeriesItem = {
     series: any;
     label: any;
@@ -23,14 +31,19 @@ declare type ChartDataSeriesItem = {
     value: number;
 };
 
+/** A chart's whole datasource: a collection of {@link ChartDataSeries}. */
 declare type ChartDatasource = ChartDataSeries[];
 
+/** Custom UI event dispatched by chart elements when the user interacts with a rendered data point (e.g. `itemclick`, `itemmouseover`). */
 declare class ChartEvent extends CustomUIEvent<ChartEventArgs> {
     constructor(type: string, eventInit: CustomEventInit<ChartEventArgs>, originalEvent: MouseEvent | TouchEvent | KeyboardEvent);
 }
 
+/** Payload carried by {@link ChartEvent}. */
 declare interface ChartEventArgs {
+    /** Gets the data item (and owning series) the event refers to. */
     readonly dataItem: ChartDataSeriesItem;
+    /** Gets the point (in page coordinates) to anchor tooltips or popups to. */
     readonly anchorPoint: Point;
 }
 
@@ -60,8 +73,12 @@ export declare namespace Components {
 
 declare const MANAGED_EVENTS: string[];
 
+/**
+ * Renders a line, spline, area or spline-area chart out of one or more {@link PacemChartSeriesElement} series.
+ */
 declare class PacemChartElement extends PacemSeriesChartElement {
     #private;
+    /** Gets or sets the chart rendering type. Default is `line`. */
     type: 'line' | 'spline' | 'area' | 'splinearea';
     /** Gets or sets how aspect ratio between x- and y-axis must be handled (considered only when xAxisType is `numeric`). Default is `adapt`.  */
     aspectRatio: 'adapt' | 'monometric' | 'logaritmic';
@@ -81,12 +98,17 @@ declare class PacemChartElement extends PacemSeriesChartElement {
     protected drawSeries(datasource: ChartDatasource): void;
 }
 
+/**
+ * Represents a single data series to be plotted within a `<pacem-chart>`-like element.
+ */
 declare class PacemChartSeriesElement extends Components_2.PacemItemElement implements ChartDataSeries {
     /** Gets or sets the - already sorted - set of chart data items. */
     datasource: ChartDataItem[];
     /** Gets or sets the series label. */
     label: string;
+    /** Gets or sets the series color. */
     color: string;
+    /** Gets or sets a value indicating whether the single data points should be rendered too. */
     datapoints: boolean;
     get values(): ChartDataItem[];
     /** @internal
@@ -94,7 +116,11 @@ declare class PacemChartSeriesElement extends Components_2.PacemItemElement impl
     _uiElements: Element[];
 }
 
+/**
+ * Renders a clustered or stacked column (bar) chart out of one or more {@link PacemChartSeriesElement} series.
+ */
 declare class PacemColumnChartElement extends PacemSeriesChartElement {
+    /** Gets or sets whether series' columns are clustered side-by-side or stacked. Default is `cluster`. */
     type: 'cluster' | 'stack';
     /** Set a value between 0 and 1, for the columns' stack/cluster horizontal size (percentage of the available space). */
     groupWidth: number;
@@ -103,6 +129,9 @@ declare class PacemColumnChartElement extends PacemSeriesChartElement {
     drawSeries(datasource: ChartDatasource): void;
 }
 
+/**
+ * Renders a pie or doughnut chart out of one or more {@link PacemPieSliceElement} slices.
+ */
 declare class PacemPieChartElement extends Components_2.PacemItemsContainerElement<PacemPieSliceElement> {
     constructor();
     validate(item: PacemPieSliceElement): boolean;
@@ -110,7 +139,9 @@ declare class PacemPieChartElement extends Components_2.PacemItemsContainerEleme
     propertyChangedCallback(name: string, old: any, val: any, first?: boolean): void;
     /** Set a value between 0 and 1, for doughnut appearance. */
     cutout: number;
+    /** Gets or sets the target element the chart will be rendered into (a `<div>` is created and inserted, if not set). */
     target: HTMLElement;
+    /** Gets or sets a value indicating whether slices are rendered using an SVG mask (needed to properly render slice padding) instead of plain paths. */
     maskBasedRendering: boolean;
     /** Distance between two consecutive slices, in pixels. */
     slicePadding: number;
@@ -132,12 +163,19 @@ declare class PacemPieChartElement extends Components_2.PacemItemsContainerEleme
     draw(): void;
 }
 
+/**
+ * Represents a single slice within a `<pacem-pie-chart>`.
+ */
 declare class PacemPieSliceElement extends Components_2.PacemItemElement implements ChartDataItem {
     protected findContainer(): PacemPieChartElement;
     private get chart();
+    /** Gets or sets the slice value. */
     value: number;
+    /** Gets or sets the slice label. */
     label: string;
+    /** Gets or sets the slice color. */
     color: string;
+    /** Gets or sets the slice's polar coordinates (radius and angle, both normalized), computed automatically while drawing. */
     normalizedPolarCoords: {
         radius: number;
         angle: number;
@@ -153,15 +191,22 @@ declare class PacemPieSliceElement extends Components_2.PacemItemElement impleme
     private _broadcastHandler;
 }
 
+/**
+ * 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`).
+ */
 declare abstract class PacemSeriesChartElement extends Components_2.PacemItemsContainerElement<PacemChartSeriesElement> {
     constructor();
     validate(item: PacemChartSeriesElement): boolean;
+    /** Gets or sets the target element the chart will be rendered into (a `<div>` is created and inserted, if not set). */
     target: HTMLElement;
     /**
      Gets or sets the x-axis type for sorting, measuring and labeling.
      */
     xAxisType: 'string' | 'date' | 'number';
+    /** Gets or sets where the x-axis labels are positioned, or `none` to hide them. */
     xAxisPosition: 'bottom' | 'top' | 'none';
+    /** Gets or sets the chart datasource, overriding the series declared as child `<pacem-chart-series>` elements. */
     datasource: ChartDatasource;
     /** Maximum number of horizontal grid lines. */
     yAxisDensity: number;
@@ -171,7 +216,9 @@ declare abstract class PacemSeriesChartElement extends Components_2.PacemItemsCo
     yAxisMin: number;
     /** Maximum y value. */
     yAxisMax: number;
+    /** Gets or sets the `Intl.NumberFormat` options used to format the y-axis labels. */
     yAxisFormat: Intl.NumberFormatOptions;
+    /** Gets or sets the `Intl.NumberFormat` or `Intl.DateTimeFormat` options used to format the x-axis labels. */
     xAxisFormat: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions;
     register(item: PacemChartSeriesElement): boolean;
     unregister(item: PacemChartSeriesElement): boolean;