Skip to content
Snippets Groups Projects
Commit f20e9f43 authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

format with prettier

parent 8aa519e4
No related branches found
No related tags found
No related merge requests found
Pipeline #76539 passed
Stage: build
Stage: deploy
Hide whitespace changes
Inline Side-by-side
.vscode/settings.json
+ 0
− 1
View file @ f20e9f43
......@@ -2,7 +2,6 @@
"[markdown]": {
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
},
"cSpell.language": "fr,en",
"cSpell.words": [
......
docs/ecolyo/functionalities/consumption.md
+ 41
− 41
View file @ f20e9f43
......@@ -92,7 +92,7 @@ It is split in 3 distinct parts:
| Component | Rules |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ConsumptionVisualizer | <ul><li>Calls the _DataloadConsumptionVisualizer_ component that shows the dataload of the selected timeStep and fluid</li><li>For multifluid, we show the total consumption of all connected fluid, and the consumption fluid by fluid, all in €</li><li>We display a message according to the data state as explained in the [DataLoad Consumption Visualizer](./#dataload-consumption-visualizer)</li></ul> |
| FluidSlides | This component calls the fluidSwipe component which is handled by the library _react-swipeable-views_, and allows the user to swipe across the selected timestep. This library loads the slides before and after the current slide, so we reduce the loading time between slides. |
| FluidSlides | This component calls the fluidSwipe component which is handled by the library _react-swipeable-views_, and allows the user to swipe across the selected timestep. This library loads the slides before and after the current slide, so we reduce the loading time between slides. |
| TimeStepSelector | This component allows the user to change the current Timestep, or to return to today's date with a button |
## DataLoad Consumption Visualizer
......@@ -108,14 +108,14 @@ The data state is define in the "ConsumptionFormatter" service following theses
#### For single fluid
| Condition | State |
| -------------------------------------------------------------------------------- | -------- |
| Before the first data available | EMPTY |
| Between the first and last data available & value of load is not empty | VALID |
| Condition | State |
| ------------------------------------------------------------------------------------- | -------- |
| Before the first data available | EMPTY |
| Between the first and last data available & value of load is not empty | VALID |
| Between the first and last data available & no document in database for the given day | HOLE |
| After the last data available & Before today & in the dataDelayOffset period | UPCOMING |
| After the last data available & Before today & not in the dataDelayOffset period | MISSING |
| After today | COMING |
| After the last data available & Before today & in the dataDelayOffset period | UPCOMING |
| After the last data available & Before today & not in the dataDelayOffset period | MISSING |
| After today | COMING |
#### For multifluid
......@@ -133,21 +133,21 @@ The data state is define in the "ConsumptionFormatter" service following theses
This display appear instead of the traditional one (described below). It is used to display a general message which override the value. Here are the rules :
| Condition | Displayed label | Comments |
| --- | --- | --- |
| Single fluid && dataload state = EMPTY | Pas de données | |
| Single fluid && dataload state = VALID | - | |
| Single fluid && dataload state = HOLE | Pas de données | |
| Single fluid && dataload state = MISSING | Données manquantes | Displayed in red and clickable (scroll to the konnector card) |
| Single fluid && dataload state = UPCOMING | À venir | |
| Single fluid && dataload state = COMING | À venir | |
| Multi fluid && dataload state = AGGREGATED_EMPTY | Pas de données | |
| Multi fluid && dataload state = AGGREGATED_WITH_EMPTY | - | |
| Multi fluid && dataload state = AGGREGATED_VALID | - | |
| Multi fluid && dataload state = AGGREGATED_WITH_COMING | - | |
| Multi fluid && dataload state = AGGREGATED_HOLE_OR_MISSING | Données manquantes | |
| Multi fluid && dataload state = AGGREGATED_WITH_HOLE_OR_MISSING | - | |
| Multi fluid && dataload state = AGGREGATED_COMING | À venir | |
| Condition | Displayed label | Comments |
| --------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- |
| Single fluid && dataload state = EMPTY | Pas de données | |
| Single fluid && dataload state = VALID | - | |
| Single fluid && dataload state = HOLE | Pas de données | |
| Single fluid && dataload state = MISSING | Données manquantes | Displayed in red and clickable (scroll to the konnector card) |
| Single fluid && dataload state = UPCOMING | À venir | |
| Single fluid && dataload state = COMING | À venir | |
| Multi fluid && dataload state = AGGREGATED_EMPTY | Pas de données | |
| Multi fluid && dataload state = AGGREGATED_WITH_EMPTY | - | |
| Multi fluid && dataload state = AGGREGATED_VALID | - | |
| Multi fluid && dataload state = AGGREGATED_WITH_COMING | - | |
| Multi fluid && dataload state = AGGREGATED_HOLE_OR_MISSING | Données manquantes | |
| Multi fluid && dataload state = AGGREGATED_WITH_HOLE_OR_MISSING | - | |
| Multi fluid && dataload state = AGGREGATED_COMING | À venir | |
### Display of the load values
......@@ -168,30 +168,30 @@ Used to display the load or price in function of following rules :
Used to display the detail just below the main value. The information displayed are :
| Condition | Displayed information |
| -------------------------------------- | ---------------------------------------------------------------------------------------- |
| Single fluid | Display the load converted in euro |
| Condition | Displayed information |
| ----------------------------- | ----------------------------------------------------------- |
| Single fluid | Display the load converted in euro |
| Multifluid without comparison | Display the load converted in euro for each available fluid |
| Multifluid with comparison | Display nothing |
| Multifluid with comparison | Display nothing |
### Information (component: InfoDataConsumptionVisualizer)
In addition of the value / load / message displayed, we can displayed an additional information.
| Condition | Displayed label | Comments |
| --- | --- | --- |
| Single fluid && dataload state = EMPTY | Pourquoi n’ai-je pas de données ? | |
| Single fluid && dataload state = VALID | - | |
| Single fluid && dataload state = HOLE | Pourquoi n’ai-je pas de données ? | |
| Single fluid && dataload state = MISSING | Dernières données disponibles : XX/XX/XX | |
| Single fluid && dataload state = UPCOMING | Dernières données disponibles : XX/XX/XX | |
| Single fluid && dataload state = COMING | Dernières données disponibles : XX/XX/XX | |
| Multi fluid && dataload state = AGGREGATED_EMPTY | Pourquoi n’ai-je pas de données ? | |
| Multi fluid && dataload state = AGGREGATED_VALID | - | |
| Multi fluid && dataload state = AGGREGATED_WITH_COMING | - | |
| Multi fluid && dataload state = AGGREGATED_HOLE_OR_MISSING | Dernières données complètes : XX/XX/XX | |
| Multi fluid && dataload state = AGGREGATED_WITH_HOLE_OR_MISSING | Dernières données complètes : XX/XX/XX | |
| Multi fluid && dataload state = AGGREGATED_COMING | Dernières données complètes : XX/XX/XX | |
| Condition | Displayed label | Comments |
| --------------------------------------------------------------- | ---------------------------------------- | -------- |
| Single fluid && dataload state = EMPTY | Pourquoi n’ai-je pas de données ? | |
| Single fluid && dataload state = VALID | - | |
| Single fluid && dataload state = HOLE | Pourquoi n’ai-je pas de données ? | |
| Single fluid && dataload state = MISSING | Dernières données disponibles : XX/XX/XX | |
| Single fluid && dataload state = UPCOMING | Dernières données disponibles : XX/XX/XX | |
| Single fluid && dataload state = COMING | Dernières données disponibles : XX/XX/XX | |
| Multi fluid && dataload state = AGGREGATED_EMPTY | Pourquoi n’ai-je pas de données ? | |
| Multi fluid && dataload state = AGGREGATED_VALID | - | |
| Multi fluid && dataload state = AGGREGATED_WITH_COMING | - | |
| Multi fluid && dataload state = AGGREGATED_HOLE_OR_MISSING | Dernières données complètes : XX/XX/XX | |
| Multi fluid && dataload state = AGGREGATED_WITH_HOLE_OR_MISSING | Dernières données complètes : XX/XX/XX | |
| Multi fluid && dataload state = AGGREGATED_COMING | Dernières données complètes : XX/XX/XX | |
## Comparison
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment