documentation md.iplot_timeseries

docs/api_reference/index_api_reference.md

@@ -68,5 +68,6 @@ wf = md.WaterFrame()
 ### Interactive plot
 
 * [md.iplot_location(list_wf)](util/iplot/iplot_location.md): It creates a Plotly Figure with a map and a spot of the measurement location of the input WaterFrames.
+* [md.iplot_timeseries(list_wf, parameter_to_plot)](util/iplot/iplot_timeseries.md): It creates a Plotly figure with the time-series of the input parameter.
 
 Return to the [Docs Index](../index_docs.md).

docs/api_reference/util/iplot/iplot_timeseries.md

@@ -0,0 +1,41 @@
+# mooda.iplot_timeseries(*list_wf*, *parameter_to_plot*)
+
+## Reference
+
+It creates a Plotly figure with the time-series of the input parameter.
+
+### Parameters
+
+* list_wf: List of WaterFrames to be concatenated. (List of WaterFrames)
+* parameter_to_plot: Parameters to plot. (str)
+
+### Returns
+
+* figure: Dictionary of Plotly figure. (dict)
+
+## Example
+
+To reproduce the example, download the NetCDF files [MO_TS_MO_OBSEA_201401.nc](http://data.emso.eu/files/emso/obsea/mo/ts/MO_TS_MO_OBSEA_201401.nc) and [MO_TS_MO_OBSEA_201402.nc](http://data.emso.eu/files/emso/obsea/mo/ts/MO_TS_MO_OBSEA_201402.nc).
+
+```python
+import mooda as md
+import plotly.graph_objects as go
+
+path = "MO_TS_MO_OBSEA_201401.nc"
+
+wf = md.read_nc_emodnet(path)
+list_wf = [wf]
+
+fig = md.iplot_timeseries(list_wf, 'TEMP')
+go.Figure(fig).show()
+```
+
+Output:
+
+![iPlot timeseries example][iplot-timeseries]
+
+*Note: This image is NOT the real output. This image is the output, saved in PNG.*
+
+Return to [mooda.WaterFrame](../../index_api_reference.md).
+
+[iplot-timeseries]: ../img_util/iplot_timeseries_example.png