@kiwibit/chart 1.0.2 → 1.0.7

package/lib/models/chart.models.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Interface to define the Chart model.
+ *
+ * @export
+ * @interface Chart
+ */
 export interface Chart {
     title: string;
     showLegend?: boolean;
@@ -7,27 +13,115 @@ export interface Chart {
     yAxisType: AxisType;
     yAxisName: string;
     yAxisUom?: string;
+    /**
+     * If the chart should have rendering animations.
+     *
+     * @type {boolean}
+     * @memberof Chart
+     */
     hasAnimations?: boolean;
+    /**
+     * The list of Shapes that the chart must render.
+     * Each Shape corrisponds to a single chart component.
+     *
+     * @type {Shape[]}
+     * @memberof Chart
+     */
     shapes: Shape[];
+    /**
+     * Adds interaction with the chart, so that when clicking
+     * everywhere in the chart area a point gets added and it's coordinate are
+     * emitted with an event to the parent component.
+     *
+     * @type {boolean}
+     * @memberof Chart
+     */
     clickToAddPoint?: boolean;
+    /**
+     * Custom name for the "clickToAddPoint" event related button.
+     *
+     * @type {string}
+     * @memberof Chart
+     */
+    addPointCustomName?: string;
+    /**
+     * Adds the possibility to use the scroll
+     * to zoom in/out the chart area.
+     *
+     * @type {boolean}
+     * @memberof Chart
+     */
     scrollToZoom?: boolean;
+    /**
+     * Tells the chart to render or not the grid lines.
+     *
+     * @type {boolean}
+     * @memberof Chart
+     */
+    showGrid?: boolean;
 }
 export declare type Shape = Trace;
 export interface Trace {
     name?: string;
+    /**
+     * The variant of the Shape, must be of type Trace.
+     *
+     * @type {ShapeVariant}
+     * @memberof Trace
+     */
     variant: ShapeVariant;
     color?: string;
+    /**
+     * The type of the Trace drawn by the chart.
+     * Can be a line or a scatter.
+     *
+     * @type {TraceType}
+     * @memberof Trace
+     */
     type: TraceType;
     width?: number;
+    /**
+     * The list of points that define the Trace.
+     *
+     * @type {Point[]}
+     * @memberof Trace
+     */
     points: Point[];
+    /**
+     * Whether to show a smooth curve or a segmented curve.
+     *
+     * @type {boolean}
+     * @memberof Trace
+     */
     smooth?: boolean;
+    /**
+     * The style of the Trace.
+     * Can be solid, dashed or dotted.
+     *
+     * @type {TraceStyle}
+     * @memberof Trace
+     */
     style?: TraceStyle;
+    /**
+     * Option to make the Trace selected/deselected by default.
+     * A deselected Trace is obscured from the chart and can be toggled from the legend.
+     *
+     * @type {boolean}
+     * @memberof Trace
+     */
     selectedByDefault?: boolean;
 }
 export interface Point extends BasePoint {
     name?: string;
+    /**
+     * Symbol used to represent the point in the chart.
+     *
+     * @type {PointSymbol}
+     * @memberof Point
+     */
     symbol?: PointSymbol;
     symbolSize?: number;
+    color?: string;
 }
 export interface BasePoint {
     x: number;
@@ -50,13 +144,8 @@ export declare enum TraceStyle {
     DOTTED = "dotted"
 }
 export declare enum AxisType {
-    VALUE = "value",
-    CATEGORY = "category",
-    TIME = "time",
-    LOG = "log"
+    VALUE = "value"
 }
 export declare enum ShapeVariant {
-    TRACE = 0,
-    POLYGON = 1,
-    CIRCLE = 2
+    TRACE = 0
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwibit/chart",
-  "version": "1.0.2",
+  "version": "1.0.7",
   "peerDependencies": {
     "@angular/common": "^13.2.0",
     "@angular/core": "^13.2.0"