Merge pull request #156 from ImperialCollegeLondon/task/graphics-improvements

task: Graphics improvements

Author: mfacchinelli

resources/release-notes.md

@@ -4,4 +4,7 @@
 
 ## Software
 
+- (All) Add support for showing multiple lines in a stacked plot
+- (All) Allow specifying `LegendOrientation` for axes that support legends
 - (HelioSwarm) Add support for `hs-mag` v2.0.0 artifacts
+- (IMAP) Fix issue in field view where events for a sensor with no data are still being shown

src/mission/imap/+mag/+imap/+view/Field.m

@@ -122,12 +122,20 @@ function visualize(this)
                         error("Unrecognized event ""%s"".", e);
                 end
 
+                if ~primary.HasData
+                    ed(1:2) = [];
+                end
+
+                if ~secondary.HasData
+                    ed(end-1:end) = [];
+                end
+
                 eventData = [eventData, ed]; %#ok<AGROW>
             end
         end
 
         function [numHK, hkData] = getHKData(this, pwrHK, primary, secondary, primarySensor, secondarySensor)
-    
+
             numHK = 0;
             hkData = {};
 
@@ -139,9 +147,9 @@ function visualize(this)
                     hkData = [hkData, {pwrHK, ...
                         mag.graphics.style.Default(Title = compose("%s & ICU Temperatures", primarySensor), YLabel = this.TLabel, Legend = [primarySensor, "ICU"], Charts = mag.graphics.chart.Plot(YVariables = [primarySensor, "ICU"] + "Temperature"))}];
                 end
-    
+
                 if ~isempty(secondary) && secondary.HasData
-    
+
                     numHK = 1;
                     hkData = [hkData, {pwrHK, ...
                         mag.graphics.style.Default(Title = compose("%s & ICU Temperatures", secondarySensor), YLabel = this.TLabel, YAxisLocation = "right", Legend = [secondarySensor, "ICU"], Charts = mag.graphics.chart.Plot(YVariables = [secondarySensor, "ICU"] + "Temperature"))}];

src/visualize/+mag/+graphics/+chart/Stackedplot.m

@@ -42,13 +42,25 @@
                 error("Mismatch in number of colors for number of plots.");
             end
 
+            % Check if layout already has a stack layout.
+            existingGraphics = layout.Children;
+
+            if isempty(existingGraphics) || ~isequal(existingGraphics(1).Type, "tiledlayout")
+                stackLayout = tiledlayout(layout, Ny, 1, TileSpacing = "tight", Padding = "tight", Layout = axes.Layout);
+            else
+                stackLayout = existingGraphics(1);
+            end
+
             % Create custom stacked plot.
             graph = matlab.graphics.chart.primitive.Line.empty(0, Ny);
-            stackLayout = tiledlayout(layout, Ny, 1, TileSpacing = "tight", Padding = "tight", Layout = axes.Layout);
 
             for y = 1:Ny
 
-                ax = nexttile(stackLayout);
+                ax = nexttile(stackLayout, y);
+
+                hold(ax, "on");
+                resetAxesHold = onCleanup(@() hold(ax, "off"));
+
                 graph(y) = plot(ax, xData, yData(:, y), this.MarkerStyle{:}, this.LineCustomization{:}, Color = this.Colors(y, :));
 
                 if this.EventsVisible && ~isempty(data.Properties.Events)

src/visualize/+mag/+graphics/+mixin/LegendSupport.m

@@ -6,6 +6,8 @@
         Legend (1, :) string = string.empty()
         % LEGENDLOCATION Location of legend.
         LegendLocation (1, 1) string = "best"
+        % LEGENDORIENTATION Orientation of legend.
+        LegendOrientation (1, 1) string = "vertical"
     end
 
     methods (Access = protected)
@@ -17,7 +19,7 @@
             if isempty(this.Legend)
                 l = matlab.graphics.illustration.Legend.empty();
             else
-                l = legend(axes, this.Legend, Location = this.LegendLocation);
+                l = legend(axes, this.Legend, Location = this.LegendLocation, Orientation = this.LegendOrientation);
             end
         end
     end

src/visualize/+mag/+graphics/+style/Stackedplot.m

@@ -17,7 +17,7 @@
 
             arguments
                 options.?mag.graphics.style.Stackedplot
-                options.Charts (1, 1) mag.graphics.chart.Stackedplot
+                options.Charts (1, :) mag.graphics.chart.Stackedplot
                 options.LegendLocation (1, 1) string {mustBeMember(options.LegendLocation, ["north", "south", "east", "west"])} = "south"
             end
 
@@ -53,7 +53,7 @@
 
             if ~isempty(this.YLabels)
 
-                for i = 1:numel(axes)
+                for i = 1:numel(this.YLabels)
                     l(i) = ylabel(axes(i), this.YLabels(i));
                 end
             end

tests/unit/visualize/chart/tStackedplot.m

@@ -8,6 +8,87 @@
 
     methods (Test)
 
+        % Test that stackedplot charts can view more than one line per
+        % axis.
+        function stackedplotWithMultipleLines(testCase)
+
+            % Set up.
+            data = testCase.createTestDataWithEvents(SetDuration = false, SetEndTime = false);
+
+            chart1 = mag.graphics.chart.Stackedplot(YVariables = ["A", "B", "C"]);
+            chart2 = mag.graphics.chart.Stackedplot(YVariables = ["C", "A", "B"]);
+
+            % Exercise.
+            f = mag.graphics.visualize(data, mag.graphics.style.Stackedplot(Charts = [chart1, chart2]));
+            testCase.addTeardown(@() close(f));
+
+            % Verify.
+            % The chart should only return the main objects, but the figure
+            % should also show two vertical lines per plot.
+            testCase.assertTrue(isvalid(f), "Figure should be valid.");
+
+            tl = f.Children.Children(1);
+            testCase.assertClass(tl, "matlab.graphics.layout.TiledChartLayout", "Child should be a tiled layout.");
+
+            axes = mag.test.getAllAxes(tl);
+            graph = [axes.Children];
+
+            testCase.assertSize(graph, [2, 3], "Number of graphs should match expectation.");
+            testCase.assertClass(graph, "matlab.graphics.chart.primitive.Line", "Graphs should be lines.");
+
+            testCase.verifyEqual(graph(1, 1).YData, data.B', "Graph data should match.");
+            testCase.verifyEqual(graph(1, 2).YData, data.A', "Graph data should match.");
+            testCase.verifyEqual(graph(1, 3).YData, data.C', "Graph data should match.");
+            testCase.verifyEqual(graph(2, 1).YData, data.C', "Graph data should match.");
+            testCase.verifyEqual(graph(2, 2).YData, data.B', "Graph data should match.");
+            testCase.verifyEqual(graph(2, 3).YData, data.A', "Graph data should match.");
+        end
+
+        % Test that multiple stackedplot can be independent of each other.
+        function multipleIndependentStackedplots(testCase)
+
+            % Set up.
+            data = testCase.createTestDataWithEvents(SetDuration = false, SetEndTime = false);
+
+            chart1 = mag.graphics.chart.Stackedplot(YVariables = ["A", "B", "C"]);
+            chart2 = mag.graphics.chart.Stackedplot(YVariables = ["C", "A", "B"]);
+
+            % Exercise.
+            f = mag.graphics.visualize(data, [mag.graphics.style.Stackedplot(Charts = chart1), mag.graphics.style.Stackedplot(Charts = chart2)]);
+            testCase.addTeardown(@() close(f));
+
+            % Verify.
+            % The chart should only return the main objects, but the figure
+            % should also show two vertical lines per plot.
+            testCase.assertTrue(isvalid(f), "Figure should be valid.");
+
+            tl1 = f.Children.Children(1);
+            testCase.assertClass(tl1, "matlab.graphics.layout.TiledChartLayout", "Child should be a tiled layout.");
+
+            axes1 = mag.test.getAllAxes(tl1);
+            graph1 = [axes1.Children];
+
+            testCase.assertSize(graph1, [1, 3], "Number of graphs should match expectation.");
+            testCase.assertClass(graph1, "matlab.graphics.chart.primitive.Line", "Graphs should be lines.");
+
+            testCase.verifyEqual(graph1(1).YData, data.B', "Graph data should match.");
+            testCase.verifyEqual(graph1(2).YData, data.A', "Graph data should match.");
+            testCase.verifyEqual(graph1(3).YData, data.C', "Graph data should match.");
+
+            tl2 = f.Children.Children(3);
+            testCase.assertClass(tl2, "matlab.graphics.layout.TiledChartLayout", "Child should be a tiled layout.");
+
+            axes2 = mag.test.getAllAxes(tl2);
+            graph2 = [axes2.Children];
+
+            testCase.assertSize(graph2, [1, 3], "Number of graphs should match expectation.");
+            testCase.assertClass(graph2, "matlab.graphics.chart.primitive.Line", "Graphs should be lines.");
+
+            testCase.verifyEqual(graph2(1).YData, data.C', "Graph data should match.");
+            testCase.verifyEqual(graph2(2).YData, data.B', "Graph data should match.");
+            testCase.verifyEqual(graph2(3).YData, data.A', "Graph data should match.");
+        end
+
         % Test that instantaneous events are correctly displayed on the
         % stackedplot.
         function instantaneousEvents(testCase)