Additional import settings in Wave project file

examples/Examples.vb

@@ -1,4 +1,4 @@
-Public Class Examples
+Public Class Examples
 
     ''' <summary>
     ''' Path to the time series file
@@ -149,6 +149,12 @@
         Console.WriteLine("End date: " & ts.EndDate)
         Console.WriteLine("Average: " & ts.Average)
 
+        'set some custom display options
+        ts.DisplayOptions.Color = Color.Red
+        ts.DisplayOptions.LineStyle = Drawing2D.DashStyle.Dash
+        ts.DisplayOptions.LineWidth = 1
+        ts.DisplayOptions.ShowPoints = True
+
         'import the series in Wave
         Wave1.Import_Series(ts)
 

source/CHANGELOG.md

@@ -6,6 +6,11 @@ Development
 NEW:
 * Added a new series selection dialog for known (non-CSV) file types
 * Added the ability to reorder series from within the Time Series Properties window
+* Wave project file (WVP):
+  * Added support for additional series options in WVP files #117
+  * When saving to WVP, a new dialog allows specifying which series options to save
+  * When saving to WVP, file paths can now optionally be saved as relative
+  * WVP files are now always read and written using UTF-8 encoding
 
 CHANGED:
 * Upgrade TeeChart to v4.2023.4.18
@@ -46,6 +51,7 @@ CHANGED:
 API-CHANGES:
 * Removed property `TimeSeriesFile.nLinesPerTimestamp`
 * Removed the properties `TimeSeries.Objekt` and `TimeSeries.Type`
+* New public method `Fileformats.WVP.Write_File()` for writing a Wave project file
 
 Version 2.4.5
 -------------

source/Classes/TimeSeries.vb

@@ -54,6 +54,7 @@ Public Class TimeSeries
     Private _Type As String
     Private _Interpretation As InterpretationEnum
     Private _DataSource As TimeSeriesDataSource
+    Private _displayOptions As TimeSeriesDisplayOptions
 
 #End Region 'Members
 
@@ -256,6 +257,19 @@ Public Class TimeSeries
         End Set
     End Property
 
+    ''' <summary>
+    ''' Options for displaying the time series
+    ''' </summary>
+    ''' <returns></returns>
+    Public Property DisplayOptions As TimeSeriesDisplayOptions
+        Get
+            Return _displayOptions
+        End Get
+        Set(value As TimeSeriesDisplayOptions)
+            _displayOptions = value
+        End Set
+    End Property
+
     ''' <summary>
     ''' Returns the start date of the time series
     ''' </summary>
@@ -453,6 +467,7 @@ Public Class TimeSeries
         Me._unit = "-"
         Me._Interpretation = InterpretationEnum.Undefined
         Me.DataSource = New TimeSeriesDataSource(TimeSeriesDataSource.OriginEnum.Undefined)
+        Me.DisplayOptions = New TimeSeriesDisplayOptions()
         Me._nodes = New SortedList(Of DateTime, Double)
     End Sub
 
@@ -477,6 +492,7 @@ Public Class TimeSeries
         target.Metadata = Me.Metadata.Copy()
         target._Interpretation = Me.Interpretation
         target.DataSource = Me.DataSource.Copy()
+        target.DisplayOptions = Me.DisplayOptions.Copy()
         Return target
     End Function
 

source/Classes/TimeSeriesDisplayOptions.vb

@@ -0,0 +1,169 @@
+'BlueM.Wave
+'Copyright (C) BlueM Dev Group
+'<https://www.bluemodel.org>
+'
+'This program is free software: you can redistribute it and/or modify
+'it under the terms of the GNU Lesser General Public License as published by
+'the Free Software Foundation, either version 3 of the License, or
+'(at your option) any later version.
+'
+'This program is distributed in the hope that it will be useful,
+'but WITHOUT ANY WARRANTY; without even the implied warranty of
+'MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+'GNU Lesser General Public License for more details.
+'
+'You should have received a copy of the GNU Lesser General Public License
+'along with this program.  If not, see <https://www.gnu.org/licenses/>.
+'
+''' <summary>
+''' Class for storing time series display options
+''' </summary>
+Public Class TimeSeriesDisplayOptions
+
+    Private _color As Color
+    Private _linestyle As Drawing2D.DashStyle
+    Private _linewidth As Integer
+    Private _showPoints As Boolean
+
+    ''' <summary>
+    ''' Color
+    ''' </summary>
+    ''' <remarks>Default color is empty. When empty, color is automatically assigned by the chart</remarks>
+    ''' <returns></returns>
+    Public Property Color As Color
+        Get
+            Return _color
+        End Get
+        Set(value As Color)
+            _color = value
+        End Set
+    End Property
+
+    ''' <summary>
+    ''' Line style
+    ''' </summary>
+    ''' <returns></returns>
+    Public Property LineStyle As Drawing2D.DashStyle
+        Get
+            Return _linestyle
+        End Get
+        Set(value As Drawing2D.DashStyle)
+            _linestyle = value
+        End Set
+    End Property
+
+    ''' <summary>
+    ''' Line width
+    ''' </summary>
+    ''' <returns></returns>
+    Public Property LineWidth As Integer
+        Get
+            Return _linewidth
+        End Get
+        Set(value As Integer)
+            _linewidth = value
+        End Set
+    End Property
+
+    ''' <summary>
+    ''' Flag to show series points
+    ''' </summary>
+    ''' <returns></returns>
+    Public Property ShowPoints As Boolean
+        Get
+            Return _showPoints
+        End Get
+        Set(value As Boolean)
+            _showPoints = value
+        End Set
+    End Property
+
+    ''' <summary>
+    ''' Creates a new TimeSeriesDisplayOption instance with default properties
+    ''' </summary>
+    ''' <remarks>Default Color is empty in order to allow automatic color assignment by the chart</remarks>
+    Public Sub New()
+        Me.Color = Color.Empty
+        Me.LineStyle = Drawing2D.DashStyle.Solid
+        Me.LineWidth = 2
+        Me.ShowPoints = False
+    End Sub
+
+    ''' <summary>
+    ''' Returns a copy of the instance
+    ''' </summary>
+    ''' <returns></returns>
+    Public Function Copy() As TimeSeriesDisplayOptions
+        Dim displayOptions As New TimeSeriesDisplayOptions() With {
+            .Color = Me.Color,
+            .LineStyle = Me.LineStyle,
+            .LineWidth = Me.LineWidth,
+            .ShowPoints = Me.ShowPoints
+        }
+        Return displayOptions
+    End Function
+
+    ''' <summary>
+    ''' Sets the color from a color string
+    ''' </summary>
+    ''' <remarks>
+    ''' Must be either the name of a known color: https://learn.microsoft.com/en-us/dotnet/api/system.drawing.knowncolor
+    ''' or a hexadecimal representation of ARGB values
+    ''' </remarks>
+    ''' <param name="colorString">the color string</param>
+    Public Sub SetColor(colorString As String)
+        If [Enum].IsDefined(GetType(KnownColor), colorString) Then
+            Me.Color = Drawing.Color.FromName(colorString)
+        Else
+            Try
+                'try to convert a hexadecimal representation of ARGB values
+                Dim argb As Integer = Int32.Parse(colorString, Globalization.NumberStyles.HexNumber)
+                Me.Color = Color.FromArgb(argb)
+            Catch e As FormatException
+                Log.AddLogEntry(levels.warning, $"Color '{colorString}' is not recognized!")
+            End Try
+        End If
+    End Sub
+
+    ''' <summary>
+    ''' Sets the line style from a string
+    ''' </summary>
+    ''' <remarks>Recognized line styles: https://learn.microsoft.com/en-us/dotnet/api/system.drawing.drawing2d.dashstyle</remarks>
+    ''' <param name="lineStyle">the line style as string</param>
+    Public Sub SetLineStyle(lineStyle As String)
+        If Not [Enum].IsDefined(GetType(Drawing2D.DashStyle), lineStyle) Then
+            Log.AddLogEntry(levels.warning, $"Line style '{lineStyle}' is not recognized!")
+        Else
+            Me.LineStyle = [Enum].Parse(GetType(Drawing2D.DashStyle), lineStyle)
+        End If
+    End Sub
+
+    ''' <summary>
+    ''' Sets the line width from a string
+    ''' </summary>
+    ''' <remarks>string must be convertible to an integer</remarks>
+    ''' <param name="lineWidth">line width as string</param>
+    Public Sub SetLineWidth(lineWidth As String)
+        Dim lineWidthInt As Integer
+        If Not Integer.TryParse(lineWidth, lineWidthInt) Then
+            Log.AddLogEntry(levels.warning, $"Line width '{lineWidth}' can not be converted to integer!")
+        Else
+            Me.LineWidth = lineWidthInt
+        End If
+    End Sub
+
+    ''' <summary>
+    ''' Sets the ShowPoints property from a string
+    ''' </summary>
+    ''' <remarks>string must be convertible to a boolean</remarks>
+    ''' <param name="showPoints">whether to show points</param>
+    Public Sub SetShowPoints(showPoints As String)
+        Select Case showPoints.ToLower()
+            Case "true", "y", "1"
+                Me.ShowPoints = True
+            Case Else
+                Me.ShowPoints = False
+        End Select
+    End Sub
+
+End Class

source/Controllers/WaveController.vb

@@ -387,20 +387,46 @@ Friend Class WaveController
     ''' <remarks></remarks>
     Private Sub SaveProjectFile_Click(sender As System.Object, e As System.EventArgs)
 
+        If _model.TimeSeries.Count = 0 Then
+            MsgBox("No time series to save!", MsgBoxStyle.Exclamation)
+            Exit Sub
+        End If
+
         Try
+            'show save project file dialog
             Dim dlgres As DialogResult
-
-            'Prepare SaveFileDialog
-            View.SaveFileDialog1.Title = "Save project file"
-            View.SaveFileDialog1.Filter = "Wave project files (*.wvp)|*wvp"
-            View.SaveFileDialog1.DefaultExt = "wvp"
-            View.SaveFileDialog1.OverwritePrompt = True
-
-            'Show dialog
-            dlgres = View.SaveFileDialog1.ShowDialog()
+            Dim dlg As New SaveProjectFileDialog()
+            dlgres = dlg.ShowDialog()
 
             If dlgres = Windows.Forms.DialogResult.OK Then
-                Call _model.SaveProjectFile(View.SaveFileDialog1.FileName)
+                'collect display options from chart and store them in timeseries
+                Dim tsList As New List(Of TimeSeries)
+                For Each ts As TimeSeries In _model.TimeSeries.ToList()
+                    For Each series As Steema.TeeChart.Styles.Series In View.TChart1.Series
+                        If series.Tag = ts.Id Then
+                            If TypeOf series Is Steema.TeeChart.Styles.Line Then
+                                Dim line As Steema.TeeChart.Styles.Line = CType(series, Steema.TeeChart.Styles.Line)
+                                ts.DisplayOptions.Color = line.Color
+                                ts.DisplayOptions.LineStyle = line.LinePen.Style
+                                ts.DisplayOptions.LineWidth = line.LinePen.Width
+                                ts.DisplayOptions.ShowPoints = line.Pointer.Visible
+                            End If
+                            Exit For
+                        End If
+                    Next
+                    tsList.Add(ts)
+                Next
+                Call Fileformats.WVP.Write_File(tsList, dlg.FileName,
+                                                saveRelativePaths:=dlg.SaveRelativePaths,
+                                                saveTitle:=dlg.SaveTitle,
+                                                saveUnit:=dlg.SaveUnit,
+                                                saveInterpretation:=dlg.SaveInterpretation,
+                                                saveColor:=dlg.SaveColor,
+                                                saveLineStyle:=dlg.SaveLineStyle,
+                                                saveLineWidth:=dlg.SaveLineWidth,
+                                                savePointsVisibility:=dlg.SavePointsVisibility
+                )
+                MsgBox($"Wave project file {dlg.FileName} saved.", MsgBoxStyle.Information)
             End If
 
         Catch ex As Exception
@@ -2174,7 +2200,7 @@ Friend Class WaveController
     ''' Adds the series to the charts
     ''' Also adds the datasource to the MRU file list if the time series has a file datasource
     ''' </summary>
-    ''' <param name="ts">Die anzuzeigende Zeitreihe</param>
+    ''' <param name="ts">time series to display</param>
     Private Sub SeriesAdded(ts As TimeSeries)
 
         'Check for extreme dates not supported by TChart
@@ -2228,8 +2254,13 @@ Friend Class WaveController
         'Namen vergeben
         Line1.Title = ts.Title
 
-        'Set line width to 2
-        Line1.LinePen.Width = 2
+        'set display options
+        If Not ts.DisplayOptions.Color.IsEmpty Then
+            Line1.Color = ts.DisplayOptions.Color
+        End If
+        Line1.LinePen.Style = ts.DisplayOptions.LineStyle
+        Line1.LinePen.Width = ts.DisplayOptions.LineWidth
+        Line1.Pointer.Visible = ts.DisplayOptions.ShowPoints
 
         'Stützstellen zur Serie hinzufügen
         'Main chart
@@ -2287,8 +2318,12 @@ Friend Class WaveController
         'Namen vergeben
         Line2.Title = ts.Title
 
-        'Set line width to 2
-        Line2.LinePen.Width = 2
+        'set display options
+        If Not ts.DisplayOptions.Color.IsEmpty Then
+            Line2.Color = ts.DisplayOptions.Color
+        End If
+        Line2.LinePen.Style = ts.DisplayOptions.LineStyle
+        Line2.LinePen.Width = ts.DisplayOptions.LineWidth
 
         'Stützstellen zur Serie hinzufügen
         Line2.BeginUpdate()