smarter-charts 2.1.8 → 2.1.10

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
@@ -1,21 +1,40 @@
1
1
  # SMARTER-charts
2
2
 
3
- In this package are distributed the charts components developed for the precision irrigation system **SMARTER** by the *Business Intelligence Group* of University of Bologna.
4
-
3
+ In this package are distributed the chart components developed for the precision irrigation system **SMARTER** by the *Business Intelligence Group* of University of Bologna.
5
4
 
6
5
  ## Installation
6
+
7
7
  ```bash
8
8
  npm install smarter-charts
9
9
  ```
10
+
11
+ ## Development Setup
12
+
13
+ ```bash
14
+ # Install dependencies
15
+ npm install
16
+
17
+ # Start development server (http://localhost:5173)
18
+ npm run dev
19
+
20
+ # Build for production
21
+ npm run build
22
+
23
+ # Publish new version on npm
24
+ npm publish
25
+
26
+ # Windows utility script for cleaning the dependency and all the cached file, ensuring correct rebuild and pack for local usage in a .tgz archive
27
+ ./clean.bat
28
+ ```
29
+
10
30
  ## Usage
11
31
 
12
- All the components are exposed as Custum Elements that are defined by the funcion `registerChartComponents()` and then they can be used directly as HTML tags.
32
+ All components are exposed as Custom Elements defined by the `registerChartComponents()` function and can be used directly as HTML tags.
13
33
 
14
34
  ```js
15
35
  import {registerChartComponents} from 'smarter-charts'
16
36
 
17
37
  registerChartComponents()
18
-
19
38
  ```
20
39
 
21
40
  ## Global `config` Prop
@@ -50,12 +69,14 @@ config: {
50
69
  | `<meancountor-chart-smarter>` | Heatmap of monitored soil portion for **mean** of matric potential in a given period|
51
70
  | `<stdcountor-chart-smarter>` | Heatmap of monitored soil portion for **standard deviation** of matric potential in a given period |
52
71
  | `<dripperandpluv-chart-smarter>` | Line chart showing irrigation and rainfall |
53
- | `<signals-linechart-chart-smarter>` | Line chart for signals of requested type | `:hideOnMissingSignal` flage that indicates if hide chart when no signals retrieved
72
+ | `<signals-linechart-chart-smarter>` | Line chart for signals of requested type | `:hideOnMissingSignal` flag that indicates if the chart should be hidden when no signals are retrieved
54
73
  | `<humiditymap-smarter>` | Heatmap of monitored soil portion showing the matric potential | `:selectedTimestamp` timestamp of image to show
55
74
  | `<humiditymultiline-chart-smarter>` | Area chart of humidity levels over times | `@selectTimestamp` events emitted containing the timestamp clicked
56
75
  | `<heatmap-animation-smarter>` | Animation of humidity heatmap over time |
57
76
  | `<optimal-humidity-heatmap-smarter>` | Heatmaps of optimal soil state to obtain with cell weights | `:selectedTimestamp` timestamp of image to show <br>`:showDistance` flag that indicates if show the distance matrix
58
- | `<calendar-smarter>` | Calendar with irrigation events | `:isEditable` flag that indicates if events can be editated
59
- | `<water-aggregate-chart-smarter>` | Bar chart to summarize daily irrigation and rainfalls|
77
+ | `<calendar-smarter>` | Calendar with irrigation events | `:isEditable` flag that indicates if events can be edited
78
+ | `<water-aggregate-chart-smarter>` | Bar chart to summarize daily irrigation and rainfalls| `:extraParams` object with additional aggregation parameters|
60
79
 
61
80
 
81
+ ## License
82
+ This project is maintained by the Business Intelligence Group at University of Bologna.