The way the main page is served (where you can select the instrument you want to interact with) has not been decided yet, even if its code is in this repository.
# Client - developer documentation
### Initialization/navigation
## File tree
```
./client/
components/... <-- See section Components
cssFiles/... <-- Contains some CSS files for the MHTL files at the root of the folder
externalFiles/... <-- Contains some CSS and JS files for external libraries
jsFiles/... <-- Contains the main JS files for the app (except the components)
res/... <-- Contains the images used in the client
```
## Initialization/navigation
For a selected instrument, there is a single HTML file that holds the application : the `SEAWebClient.html` file, which is served as the main route. It includes all the JS files needed, meaning all the JS files located in the `client/jsFiles` folder excepted `SeaWebClientStart.js`, plus the external librairies (`client/externalFiles/`) and the components (`client/components/`).
The entry point is the `SEAWebClientMain.js`, which has a `window.onload` function. First, the grid that holds the different parts (graphics, console...) is computed depending on the screen size. Then, the connexion with the server is initiated with the `buildUpdateConnection` function, located in `SeaWebClientCommunication.js`.
The entry point is the `SEAWebClientMain.js`, which has a `window.onload` function. First, the grid that holds the different parts (graphics, console...) is computed depending on the screen size. Then, the connection with the server is initiated with the `buildUpdateConnection` function, located in `SeaWebClientCommunication.js`.
This function calls the /update route, which will initiate the SSE connexion, retrieving an id, the name of the instrument and the device currently running to the client. The id will be used for all the API calls. When all this information is received, the `loadFirstBlocks()` function is called (`SeaWebClientMain.js`) to populate an array of routes to call, so we can get the content of each block sequentially. Its content is defined by the global variables defined in `SeaWebClientMain.js`, more precisely in the calling cascade of the `treat()` method on the `Settings` function (still in the same file).
This function calls the /update route, which will initiate the SSE connection, retrieving an id, the name of the instrument and the device currently running to the client. The id will be used for all the API calls. When all this information is received, the `loadFirstBlocks()` function is called (`SeaWebClientMain.js`) to populate an array of routes to call, so we can get the content of each block sequentially. Its content is defined by the global variables defined in `SeaWebClientMain.js`, more precisely in the calling cascade of the `treat()` method on the `Settings` function (still in the same file).
The calling cascade is initiated with the `nextInitCommand()` function (`SeaWebClientMain.js`), called just after the `loadFirstBlocks()` function. Every response of each command will be treated in the switch statement of the `successHandler()` function (in `SeaWebClientCommunication.js`). Specifically, the content of each block is dynamically created in JS when the response of the different init commands are received.
### Components
## Components
A component is composed of a JS file and its CSS file. They are grouped in the folder `client/components`. A component is basically a class that inherits from `HTMLELement`, and implement the method connectedCallback, where the HTML of the component has to be defined. Then, it has to be added to the customElements via the line `customElements.define("<component-name>", <ComponentClass>)`. The component's name has to contain dash, otherwise an error is thrown.
The export popup and the dates popup are considered as components just to separate their code from the rest.
The export popup, the dates popup and the curves settings popup are considered as components just to separate their code from the rest.
## Miscellaneous
### About updating graphics
- When the server is pushing data, the newly received data is appened to the current curves (on livemode).
- When zooming in the x direction, when the zoom is complete (for e.g. meaning that there are no longer enough mouse wheel step in a certain range of time), then the resolution is computed, the client asks for the data within the new viewing window with the given resolution, and then sets (overwrites) the data for the curves. This process is done only when zooming out, and we have zoomed in by at least 50% of the previous viewing window
- When zooming in the x direction, when the zoom is complete (for e.g. meaning that there are no longer enough mouse wheel step in a certain range of time), then the resolution is computed, the client asks for the data within the new viewing window with the given resolution, and then sets (overwrites) the data for the curves. This process is done only when zooming out, and we have zoomed in by at least 50% of the previous viewing window.
### About livemode
A user is in livemode when the "now" date is in the viewing window. When the last point gets more recent than the right most value, the viewing window is shrinked, keeping the left mose value.
-A user is in livemode when the "now" date is in the viewing window. When the last point gets more recent than the right most value, the viewing window is shrinked, keeping the left mose value.
- Every plain minute, all the curves are synchronized. For the curve that have not receive any new data, their last known point is retreived at the "now" date.
Every plain minute, all the curves are synchronized. For the curve that have not receive any new data, their last known point is retreived at the "now" date.
### About the user configuration for the graphs
The local storage is used to save the user configuration. The key in an integer, and the value is a stringified JSON object, which looks like the following :
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
l_samenv