ods-charts - npm Package Compare versions

Comparing version 0.1.0-alpha.1 to 0.1.0-alpha.2

dist/src/theme/css-themes/css-themes.d.ts

@@ -8,3 +8,3 @@ export declare enum ODSChartsCSSThemesNames {
 /**
- * ODSChartsItemCSSDefinition defines classes or styles to be added on generated HTML element
+ * ODSChartsItemCSSDefinition defines the classes or styles to be added on generated HTML element
  */
@@ -39,3 +39,3 @@ export declare class ODSChartsItemCSSDefinition {
 /**
- * ODSChartsItemGroupCSSDefinition defines classes an styles to be add on code generated by the library.
+ * ODSChartsItemGroupCSSDefinition defines the classes an styles to be add on code generated by the library.
  */
@@ -74,3 +74,3 @@ export declare class ODSChartsItemGroupCSSDefinition {
 /**
- * ODSChartsCSSThemeDefinition defines classes an styles to be add on code generated by the library.
+ * ODSChartsCSSThemeDefinition defines the classes an styles to be add on code generated by the library.
  */
@@ -88,6 +88,6 @@ export declare class ODSChartsCSSThemeDefinition {
 /**
- * Preconfigured {@link ODSChartsCSSThemeDefinition}
- * - ODSCharts.ODSChartsCSSThemes.NONE : the generated code will use an embedded independant style auto-generated by the library.
- * - ODSCharts.ODSChartsCSSThemes.BOOSTED5 : the generated code will use css of the Boosted 5 framework.
- * - ODSCharts.ODSChartsCSSThemes.BOOSTED4 : the generated code will use css of the Boosted 4 framework.
+ * Pre-configured {@link ODSChartsCSSThemeDefinition}
+ * - ODSCharts.ODSChartsCSSThemes.NONE: the generated code will use an embedded independent style auto-generated by the library.
+ * - ODSCharts.ODSChartsCSSThemes.BOOSTED5: the generated code will use Boosted 5 framework CSS.
+ * - ODSCharts.ODSChartsCSSThemes.BOOSTED4: the generated code will use Boosted 4 framework CSS.
  */
@@ -94,0 +94,0 @@ export declare const ODSChartsCSSThemes: {

dist/src/theme/dark/ODS.categorical-colors.darker-tints.d.ts

@@ -1,3 +0,3 @@
-export declare const DARK_CATEGORICAL_COLORS_DAKER_TINTS: {
+export declare const DARK_CATEGORICAL_COLORS_DARKER_TINTS: {
     color: string[];
 };

dist/src/theme/dark/ODS.common.d.ts

@@ -1,3 +0,3 @@
-export declare const DARK_COMON: {
+export declare const DARK_COMMON: {
     backgroundColor: string;
 };

dist/src/theme/light/ODS.categorical-colors.darker-tints.d.ts

@@ -1,3 +0,3 @@
-export declare const LIGHT_CATEGORICAL_COLORS_DAKER_TINTS: {
+export declare const LIGHT_CATEGORICAL_COLORS_DARKER_TINTS: {
     color: string[];
 };

dist/src/theme/light/ODS.common.d.ts

@@ -1,3 +0,3 @@
-export declare const LIGHT_COMON: {
+export declare const LIGHT_COMMON: {
     backgroundColor: string;
 };

dist/src/theme/ods-chart-theme.d.ts

 import { ODSChartsCSSThemeDefinition, ODSChartsCSSThemesNames } from './css-themes/css-themes';
 import { ODSChartsPopoverConfig, ODSChartsPopoverDefinition } from './popover/ods-chart-popover-definitions';
-export declare enum ODSCHartsCategoricalColorsSet {
+export declare enum ODSChartsCategoricalColorsSet {
     DEFAULT_SUPPORTING_COLORS = "supportingColors",
@@ -12,7 +12,7 @@ DARKER_TINTS = "darkerTints",
 /**
- * ODSCHartsCustomCategoricalColor is used to define a color.
+ * ODSChartsCustomCategoricalColor is used to define a color.
  *
  * - It can be the string value of the color
  *
- * - Or it can be a {@link ODSCHartsCategoricalColor} to reference a color of one predefined set of Orange Design System colors.
+ * - Or it can be a {@link ODSChartsCategoricalColor} to reference a color of one predefined set of Orange Design System colors.
  *
@@ -22,3 +22,3 @@ * example
  * {
- *  colorPalette: ODSCharts.ODSCHartsCategoricalColorsSet.DARKER_TINTS,
+ *  colorPalette: ODSCharts.ODSChartsCategoricalColorsSet.DARKER_TINTS,
  *  colorIndex: 0,
@@ -28,18 +28,18 @@ * }
  */
-export type ODSCHartsCustomCategoricalColor = ODSCHartsCategoricalColor | string;
+export type ODSChartsCustomCategoricalColor = ODSChartsCategoricalColor | string;
 /**
- * ODSCHartsCategoricalColor is a color extract from one set of color of Orange Design System.
+ * ODSChartsCategoricalColor is a color extract from one set of color of Orange Design System.
  */
-export interface ODSCHartsCategoricalColor {
+export interface ODSChartsCategoricalColor {
     /**
-     * The {@link ODSCHartsCategoricalColorsSet} to be used to extract a specific color.
-     * (example {@link ODSCHartsCategoricalColorsSet.DEFAULT_SUPPORTING_COLORS})
+     * The {@link ODSChartsCategoricalColorsSet} to be used to extract a specific color.
+     * (example {@link ODSChartsCategoricalColorsSet.DEFAULT_SUPPORTING_COLORS})
      */
-    colorPalette: ODSCHartsCategoricalColorsSet;
+    colorPalette: ODSChartsCategoricalColorsSet;
     /**
-     * Index of the color in the {@link ODSCHartsCategoricalColorsSet}
+     * Index of the color in the {@link ODSChartsCategoricalColorsSet}
      */
     colorIndex: number;
 }
-export declare enum ODSCHartsSequentialColorsSet {
+export declare enum ODSChartsSequentialColorsSet {
     SEQUENTIAL_BLUE = "blue",
@@ -69,7 +69,7 @@ SEQUENTIAL_GREEN = "green",
      * It can be
-     * - one of the predefined {@link ODSCHartsCategoricalColorsSet} defined in Orange Design System
+     * - one of the predefined {@link ODSChartsCategoricalColorsSet} defined in Orange Design System
      *
-     * example: `ODSCharts.ODSCHartsCategoricalColorsSet.DEFAULT_SUPPORTING_COLORS`.
+     * example: `ODSCharts.ODSChartsCategoricalColorsSet.DEFAULT_SUPPORTING_COLORS`.
      *
-     * - Or it can be an array of colors {@link ODSCHartsCustomCategoricalColor}
+     * - Or it can be an array of colors {@link ODSChartsCustomCategoricalColor}
      *
@@ -81,3 +81,3 @@ * example:
      *          colorPalette:
-     *            ODSCharts.ODSCHartsCategoricalColorsSet
+     *            ODSCharts.ODSChartsCategoricalColorsSet
      *              .DEFAULT_SUPPORTING_COLORS,
@@ -88,3 +88,3 @@ *          colorIndex: 2,
      *          colorPalette:
-     *            ODSCharts.ODSCHartsCategoricalColorsSet.SEQUENTIAL_GREEN,
+     *            ODSCharts.ODSChartsCategoricalColorsSet.SEQUENTIAL_GREEN,
      *          colorIndex: 0,
@@ -94,13 +94,13 @@ *        },
      * ```
-     * Default categoricalColors is {@link ODSCHartsCategoricalColorsSet.DEFAULT_SUPPORTING_COLORS}
+     * Default categoricalColors is {@link ODSChartsCategoricalColorsSet.DEFAULT_SUPPORTING_COLORS}
      */
-    categoricalColors?: ODSCHartsCategoricalColorsSet | ODSCHartsCustomCategoricalColor[];
+    categoricalColors?: ODSChartsCategoricalColorsSet | ODSChartsCustomCategoricalColor[];
     /**
-     * visualMapColor is the set of colours to be used if map graphs (like Heatmap)
+     * visualMapColor is the set of colors to be used if map graphs (like Heatmap)
      *
-     * Default visualMapColor is {@link ODSCHartsSequentialColorsSet.SEQUENTIAL_BLUE}
+     * Default visualMapColor is {@link ODSChartsSequentialColorsSet.SEQUENTIAL_BLUE}
      */
-    visualMapColor?: ODSCHartsSequentialColorsSet;
+    visualMapColor?: ODSChartsSequentialColorsSet;
     /**
-     * lineStyle soecifies the style of line in lineCharts.
+     * lineStyle specifies the style of line in lineCharts.
      *
@@ -113,3 +113,3 @@ * It can be {@link ODSChartsLineStyle.BROKEN}, {@link ODSChartsLineStyle.SMOOTH} of {@link ODSChartsLineStyle.BROKEN_WITH_POINTS}.
     /**
-     * cssTheme is the css styles to be used for designing legends and popover elements.
+     * cssTheme is the CSS styles to be used for designing legends and popover elements.
      *
@@ -161,6 +161,6 @@ * - It is possible to use one of the delivered value of {@link ODSChartsCSSThemes}
      *
-     * This manager is used to retrieve the Echarts theme and manage the chart options in accordance with the Orange Design System.
+     * This manager is used to retrieve the Apache ECharts theme and manage the chart options in accordance with the Orange Design System.
      *
      * The method takes the theme configuration as a parameter {@link ODSChartsThemeOptions}.
-     * @param options: default option used to genarate the theme
+     * @param options: default option used to generate the theme
      * @returns the theme manager
@@ -209,6 +209,6 @@ */
      * externalizeLegends() needs:
-     * - echart: the initialzed eCharts object
-     * - legendHolderSelector: the css selector of the legends container
+     * - echart: the initialized eCharts object
+     * - legendHolderSelector: the CSS selector of the legends container
      *
-     * optionnaly you can use this call to set dataOptions
+     * optionally you can use this call to set dataOptions
      * @returns returns back the theme manager object
@@ -228,5 +228,5 @@ */
      *
-     *   default value is  {@link ODSChartsPopoverManagers.NONE}: uses default ECharts templating to externalize tooltip/popover HTML element, implemting Orange Design system
+     *   default value is  {@link ODSChartsPopoverManagers.NONE}: uses default Apache ECharts template to externalize tooltip/popover HTML element, implementing Orange Design system
      *
-     * optionnaly you can use this call to set dataOptions
+     * optionally you can use this call to set dataOptions
      * @returns returns back the theme manager object
@@ -239,6 +239,6 @@ */
      * manageChartResize() needs:
-     * - echart: the initialzed eCharts object
+     * - echart: the initialized eCharts object
      * - chartId: an unique id to identify the chart
      *
-     * optionnaly you can use this call to set dataOptions
+     * optionally you can use this call to set dataOptions
      * @returns returns back the theme manager object
@@ -255,6 +255,6 @@ */
      *
-     * optionnaly you can use this call to set dataOptions
-     * @returns the Echarts options
+     * optionally you can use this call to set dataOptions
+     * @returns the Apache Echarts options
      */
     getChartOptions(dataOptions?: any): any;
 }

dist/src/theme/popover/ods-chart-popover-definitions.d.ts

@@ -43,3 +43,3 @@ import { ODSChartsCSSThemesNames } from '../css-themes/css-themes';
 }
-export declare enum ODSChartsPopoverToolipTrigger {
+export declare enum ODSChartsPopoverTooltipTrigger {
     xAxis = "xAxis",
@@ -69,3 +69,3 @@ yAxis = "yAxis",
      * - true: to display tooltip
-     * - false : to display popover
+     * - false: to display popover
      */
@@ -80,3 +80,3 @@ tooltip?: boolean;
     /**
-     * tooltipDelay is used to add a delay before moving tooltip wiith the mouse movement.
+     * tooltipDelay is used to add a delay before moving tooltip with the mouse movement.
      *
@@ -93,11 +93,11 @@ * The default value is retrieved from {@link ODSChartsPopoverDefinition} if set and otherwise is 0
     /**
-     * define how the tooltip should be triggered {@link ODSChartsPopoverToolipTrigger}
+     * define how the tooltip should be triggered {@link ODSChartsPopoverTooltipTrigger}
      *
-     * In case of axisPointer {@link ODSChartsPopoverAxisPointer.cross}, tooltipTrigger must be {@link ODSChartsPopoverToolipTrigger.grid}
+     * In case of axisPointer {@link ODSChartsPopoverAxisPointer.cross}, tooltipTrigger must be {@link ODSChartsPopoverTooltipTrigger.grid}
      *
      * Otherwise, the default value of tooltipTrigger will be
-     * - {@link ODSChartsPopoverToolipTrigger.xAxis} for a vertical graph
-     * - {@link ODSChartsPopoverToolipTrigger.yAxis} for an horizontal graph
+     * - {@link ODSChartsPopoverTooltipTrigger.xAxis} for a vertical graph
+     * - {@link ODSChartsPopoverTooltipTrigger.yAxis} for an horizontal graph
      */
-    tooltipTrigger?: ODSChartsPopoverToolipTrigger;
+    tooltipTrigger?: ODSChartsPopoverTooltipTrigger;
 }
@@ -104,0 +104,0 @@ /**

package.json

 {
   "name": "ods-charts",
   "description": "ODS Charts is based on Apache ECharts and provides Orange charts components.",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "author": "",
@@ -15,5 +15,6 @@ "contributors": [],
     "build": "webpack",
+    "netlify": "npm run build ; cp -R dist docs/ ; npm run typedoc",
     "serve": "serve .",
     "serve:vue": "serve test/vue/dist/",
-    "serve:angular": "serve test/angular/dist/angular/",
+    "serve:angular": "serve test/angular-ngx-echarts/dist/angular/",
     "serve:angular-tour-of-heroes": "serve test/angular-tour-of-heroes/dist/angular-tour-of-heroes/",
@@ -27,8 +28,8 @@ "serve:react": "serve test/react/build/",
     "serve": "^14.2.1",
-    "ts-loader": "^9.4.4",
-    "typedoc": "^0.25.3",
-    "typescript": "^5.1.6",
-    "webpack": "^5.88.2",
+    "ts-loader": "^9.5.1",
+    "typedoc": "^0.25.4",
+    "typescript": "^5.3.2",
+    "webpack": "^5.89.0",
     "webpack-cli": "^5.1.4"
   }
 }

README.md

@@ -6,3 +6,5 @@ <h1 align="center">Orange Design System Charts</h1>
   <br>
+  <a href="https://ods-charts.netlify.app/"><strong>Visit ODS Charts documentation</strong></a>
   <br>
+  <br>
   <a href="https://github.com/Orange-OpenSource/ods-charts/issues/new?assignees=-&labels=bug&template=bug_report.yml">Report bug</a>
@@ -16,2 +18,3 @@ ·
 - [Quick start](#quick-start)
+- [Status](#status)
 - [Bugs and feature requests](#bugs-and-feature-requests)
@@ -29,2 +32,9 @@ - [Contributing](#contributing)
 
+Read the [documentation](https://ods-charts.netlify.app/) for information on the library content and examples.
+
+## Status
+
+[![Netlify Status](https://api.netlify.com/api/v1/badges/3df609fb-4f36-4c09-ba31-284e261f2d8d/deploy-status)](https://app.netlify.com/sites/ods-charts/deploys)
+[![npm version](https://img.shields.io/npm/v/ods-charts?logo=npm&logoColor=fff)](https://www.npmjs.com/package/ods-charts)
+
 ## Bugs and feature requests
@@ -31,0 +41,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

56

increased by21.74%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

300189

decreased by-0.04%

No dependency changes