add visibility state and toggling of datasets

.github/workflows/ci.yml

@@ -50,6 +50,7 @@ jobs:
         if: matrix.java == env.JAVA_REFERENCE_VERSION
       - name: Codacy coverage Reporter
         if: matrix.java == env.JAVA_REFERENCE_VERSION
+        continue-on-error: true # codacy coverage sometimes fails for external PRs, ignore since it is not our main coverage tracking
         uses: codacy/[email protected]
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}

chartfx-chart/src/main/java/de/gsi/chart/Chart.java

@@ -77,10 +77,14 @@ public abstract class Chart extends HiddenSidesPane implements Observable {
     protected BooleanBinding showingBinding;
     protected final BooleanProperty showing = new SimpleBooleanProperty(this, "showing", false);
     protected final ChangeListener<? super Boolean> showingListener = (ch2, o, n) -> showing.set(n);
-    /** When true any data changes will be animated. */
+    /**
+     * When true any data changes will be animated.
+     */
     private final BooleanProperty animated = new SimpleBooleanProperty(this, "animated", true);
     // TODO: Check whether 'this' or chart contents need to be added
-    /** Animator for animating stuff on the chart */
+    /**
+     * Animator for animating stuff on the chart
+     */
     protected final ChartLayoutAnimator animator = new ChartLayoutAnimator(this);
 
     /**
@@ -310,7 +314,7 @@ protected void invalidated() {
 
     /**
      * Creates a new default Chart instance.
-     * 
+     *
      * @param axes axes to be added to the chart
      */
     public Chart(Axis... axes) {
@@ -985,6 +989,9 @@ protected void datasetsChanged(final ListChangeListener.Change<? extends DataSet
         FXUtils.assertJavaFxThread();
         while (change.next()) {
             for (final DataSet set : change.getRemoved()) {
+                // remove Legend listeners from removed datasets
+                set.updateEventListener().removeIf(l -> l instanceof DefaultLegend.DatasetVisibilityListener);
+
                 set.removeListener(dataSetDataListener);
                 dataSetChanges = true;
             }

chartfx-chart/src/main/java/de/gsi/chart/XYChart.java

@@ -257,8 +257,8 @@ public void updateAxisRange() {
         // lock datasets to prevent writes while updating the axes
         ObservableList<DataSet> dataSets = this.getAllDatasets();
         // check that all registered data sets have proper ranges defined
-        dataSets.parallelStream().forEach(dataset -> dataset.getAxisDescriptions().parallelStream().filter(axisD -> !axisD.isDefined()) //
-                                                             .forEach(axisDescription -> dataset.lock().writeLockGuard(() -> dataset.recomputeLimits(axisDescription.getDimIndex()))));
+        dataSets.parallelStream()
+                .forEach(dataset -> dataset.getAxisDescriptions().parallelStream().filter(axisD -> !axisD.isDefined()).forEach(axisDescription -> dataset.lock().writeLockGuard(() -> dataset.recomputeLimits(axisDescription.getDimIndex()))));
 
         final ArrayDeque<DataSet> lockQueue = new ArrayDeque<>(dataSets);
         recursiveLockGuard(lockQueue, () -> getAxes().forEach(chartAxis -> {
@@ -455,7 +455,7 @@ protected static void updateNumericAxis(final Axis axis, final List<DataSet> dat
         final boolean isHorizontal = axis.getSide().isHorizontal();
         final Side side = axis.getSide();
         axis.getAutoRange().clear();
-        dataSets.forEach(dataset -> dataset.lock().readLockGuard(() -> {
+        dataSets.stream().filter(DataSet::isVisible).forEach(dataset -> dataset.lock().readLockGuard(() -> {
             if (dataset.getDimension() > 2 && (side == Side.RIGHT || side == Side.TOP)) {
                 if (!dataset.getAxisDescription(DataSet.DIM_Z).isDefined()) {
                     dataset.recomputeLimits(DataSet.DIM_Z);

chartfx-chart/src/main/java/de/gsi/chart/legend/spi/DefaultLegend.java

@@ -11,6 +11,7 @@
 import javafx.collections.FXCollections;
 import javafx.collections.ListChangeListener;
 import javafx.collections.ObservableList;
+import javafx.css.PseudoClass;
 import javafx.geometry.Orientation;
 import javafx.geometry.Pos;
 import javafx.scene.Node;
@@ -24,6 +25,9 @@
 import de.gsi.chart.renderer.Renderer;
 import de.gsi.chart.utils.StyleParser;
 import de.gsi.dataset.DataSet;
+import de.gsi.dataset.event.EventListener;
+import de.gsi.dataset.event.UpdateEvent;
+import de.gsi.dataset.event.UpdatedMetaDataEvent;
 
 /**
  * A chart legend that displays a list of items with symbols in a box
@@ -35,6 +39,7 @@ public class DefaultLegend extends FlowPane implements Legend {
     private static final int GAP = 5;
     private static final int SYMBOL_WIDTH = 20;
     private static final int SYMBOL_HEIGHT = 20;
+    private static final PseudoClass disabledClass = PseudoClass.getPseudoClass("disabled");
 
     // -------------- PRIVATE FIELDS ------------------------------------------
 
@@ -56,7 +61,9 @@ protected void invalidated() {
         }
     };
 
-    /** The legend items to display in this legend */
+    /**
+     * The legend items to display in this legend
+     */
     private final ObjectProperty<ObservableList<LegendItem>> items = new SimpleObjectProperty<>(
             this, "items") {
         private ObservableList<LegendItem> oldItems = null;
@@ -106,7 +113,28 @@ public final ObservableList<LegendItem> getItems() {
 
     public LegendItem getNewLegendItem(final Renderer renderer, final DataSet series, final int seriesIndex) {
         final Canvas symbol = renderer.drawLegendSymbol(series, seriesIndex, SYMBOL_WIDTH, SYMBOL_HEIGHT);
-        return new LegendItem(series.getName(), symbol);
+        var item = new LegendItem(series.getName(), symbol);
+        item.setOnMouseClicked(event -> series.setVisible(!series.isVisible()));
+        item.pseudoClassStateChanged(disabledClass, !series.isVisible());
+        series.addListener(new DatasetVisibilityListener(item, series));
+        return item;
+    }
+
+    public static class DatasetVisibilityListener implements EventListener {
+        private LegendItem item;
+        private DataSet series;
+
+        public DatasetVisibilityListener(final LegendItem item, final DataSet series) {
+            this.item = item;
+            this.series = series;
+        }
+
+        @Override
+        public void handle(final UpdateEvent evt) {
+            if (evt instanceof UpdatedMetaDataEvent) {
+                item.pseudoClassStateChanged(disabledClass, !series.isVisible());
+            }
+        }
     }
 
     @Override
@@ -116,7 +144,7 @@ public Node getNode() {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.gsi.chart.legend.Legend#isVertical()
      */
     @Override
@@ -134,7 +162,7 @@ public final void setItems(final ObservableList<LegendItem> value) {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.gsi.chart.legend.Legend#setVertical(boolean)
      */
     @Override
@@ -144,7 +172,7 @@ public final void setVertical(final boolean value) {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see de.gsi.chart.legend.Legend#updateLegend(java.util.List, java.util.List)
      */
     @Override
@@ -221,7 +249,9 @@ public final BooleanProperty verticalProperty() {
         return vertical;
     }
 
-    /** A item to be displayed on a Legend */
+    /**
+     * A item to be displayed on a Legend
+     */
     public static class LegendItem extends Label {
         public LegendItem(final String text, final Node symbol) {
             setText(text);

chartfx-chart/src/main/java/de/gsi/chart/plugins/EditDataSet.java

@@ -975,6 +975,10 @@ protected class SelectedDataPoint extends Circle {
         }
 
         public void applyDrag(final double deltaX, final double deltaY) {
+            if (!dataSet.isVisible()) {
+                return;
+            }
+
             double nX = getX();
             double nY = getY();
             int index = getIndex();
@@ -1016,6 +1020,10 @@ public void applyDrag(final double deltaX, final double deltaY) {
         }
 
         public boolean delete() {
+            if (!dataSet.isVisible()) {
+                return false;
+            }
+
             final EditConstraints constraints = dataSet.getEditConstraints();
             int index = getIndex();
             if (constraints == null || constraints.canDelete(index)) {

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/ContourDataSetRenderer.java

@@ -411,7 +411,7 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         List<DataSet> drawnDataSet = new ArrayList<>(localDataSetList.size());
         for (int dataSetIndex = localDataSetList.size() - 1; dataSetIndex >= 0; dataSetIndex--) {
             final DataSet dataSet = localDataSetList.get(dataSetIndex);
-            if (!(dataSet instanceof GridDataSet) || dataSet.getDimension() <= 2) {
+            if (!dataSet.isVisible() || !(dataSet instanceof GridDataSet) || dataSet.getDimension() <= 2) {
                 continue; // DataSet not applicable to ContourChartRenderer
             }
 
@@ -460,9 +460,9 @@ public void shiftZAxisToRight() {
 
     public static double convolution(final double[][] pixelMatrix) {
         final double gy = pixelMatrix[0][0] * -1 + pixelMatrix[0][1] * -2 + pixelMatrix[0][2] * -1 + pixelMatrix[2][0] + pixelMatrix[2][1] * 2
-                          + pixelMatrix[2][2] * 1;
+                        + pixelMatrix[2][2] * 1;
         final double gx = pixelMatrix[0][0] + pixelMatrix[0][2] * -1 + pixelMatrix[1][0] * 2 + pixelMatrix[1][2] * -2 + pixelMatrix[2][0]
-                          + pixelMatrix[2][2] * -1;
+                        + pixelMatrix[2][2] * -1;
         return Math.sqrt(Math.pow(gy, 2) + Math.pow(gx, 2));
     }
 

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/ErrorDataSetRenderer.java

@@ -163,11 +163,13 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
             ProcessingProfiler.getTimeDiff(start, "init");
         }
 
-        List<DataSet> drawnDataSet = new ArrayList<>(localDataSetList.size());
         for (int dataSetIndex = localDataSetList.size() - 1; dataSetIndex >= 0; dataSetIndex--) {
             final int ldataSetIndex = dataSetIndex;
             stopStamp = ProcessingProfiler.getTimeStamp();
             final DataSet dataSet = localDataSetList.get(dataSetIndex);
+            if (!dataSet.isVisible()) {
+                continue;
+            }
 
             // N.B. print out for debugging purposes, please keep (used for
             // detecting redundant or too frequent render updates)
@@ -230,7 +232,6 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
                 return Optional.of(localCachedPoints);
             });
 
-            drawnDataSet.add(dataSet);
             cachedPoints.ifPresent(value -> {
                 // invoke data reduction algorithm
                 value.reduce(rendererDataReducerProperty().get(), isReducePoints(),
@@ -250,7 +251,7 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         } // end of 'dataSetIndex' loop
         ProcessingProfiler.getTimeDiff(start);
 
-        return drawnDataSet;
+        return localDataSetList;
     }
 
     /**

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/HistogramRenderer.java

@@ -139,6 +139,7 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
                     // replace DataSet with sorted variety
                     // do not need to do this for Histograms as they are always sorted by design
                     LimitedIndexedTreeDataSet newDataSet = new LimitedIndexedTreeDataSet(dataSet.getName(), Integer.MAX_VALUE);
+                    newDataSet.setVisible(dataSet.isVisible());
                     newDataSet.set(dataSet);
                     localDataSetList.set(index, newDataSet);
                 }
@@ -215,7 +216,7 @@ protected void drawBars(final GraphicsContext gc, final List<DataSet> dataSets,
         int lindex = dataSetOffset - 1;
         for (DataSet ds : dataSets) {
             lindex++;
-            if (ds.getDataCount() == 0) {
+            if (!ds.isVisible() || ds.getDataCount() == 0) {
                 continue;
             }
             final double scaleValue = isAnimate() ? scaling.getOrDefault(ds.getName(), 1.0) : 1.0;
@@ -328,7 +329,7 @@ protected static void drawPolyLineHistogram(final GraphicsContext gc, final List
         int lindex = dataSetOffset - 1;
         for (DataSet ds : dataSets) {
             lindex++;
-            if (ds.getDataCount() == 0) {
+            if (!ds.isVisible() || ds.getDataCount() == 0) {
                 continue;
             }
             final boolean isVerticalDataSet = isVerticalDataSet(ds);
@@ -382,6 +383,9 @@ protected static void drawPolyLineHistogramBezier(final GraphicsContext gc, fina
         int lindex = dataSetOffset - 1;
         for (DataSet ds : dataSets) {
             lindex++;
+            if (!ds.isVisible()) {
+                continue;
+            }
             final boolean isVerticalDataSet = isVerticalDataSet(ds);
 
             final int dimIndexAbscissa = isVerticalDataSet ? DIM_Y : DIM_X;
@@ -454,6 +458,9 @@ protected static void drawPolyLineLine(final GraphicsContext gc, final List<Data
         int lindex = dataSetOffset - 1;
         for (DataSet ds : dataSets) {
             lindex++;
+            if (!ds.isVisible()) {
+                continue;
+            }
             final boolean isVerticalDataSet = isVerticalDataSet(ds);
 
             final int dimIndexAbscissa = isVerticalDataSet ? DIM_Y : DIM_X;
@@ -510,6 +517,9 @@ protected static void drawPolyLineStairCase(final GraphicsContext gc, final List
         int lindex = dataSetOffset - 1;
         for (DataSet ds : dataSets) {
             lindex++;
+            if (!ds.isVisible()) {
+                continue;
+            }
             final boolean isVerticalDataSet = isVerticalDataSet(ds);
 
             final int dimIndexAbscissa = isVerticalDataSet ? DIM_Y : DIM_X;
@@ -693,7 +703,7 @@ public void handle(final long now) {
 
             for (final DataSet dataSet : localDataSetList) {
                 // scheme 1
-                //final Double val = scaling.put(dataSet.getName(), Math.min(scaling.computeIfAbsent(dataSet.getName(), ds -> 0.0) + 0.05, 1.0))
+                // final Double val = scaling.put(dataSet.getName(), Math.min(scaling.computeIfAbsent(dataSet.getName(), ds -> 0.0) + 0.05, 1.0))
                 // scheme 2
                 final Double val = scaling.put(dataSet.getName(), Math.min(scaling.computeIfAbsent(dataSet.getName(), ds -> 0.0) + 0.05, dataSet.getDataCount() + 1.0));
                 if (val != null && val < dataSet.getDataCount() + 1.0) {

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/LabelledMarkerRenderer.java

@@ -253,6 +253,9 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         List<DataSet> drawnDataSet = new ArrayList<>(localDataSetList.size());
         for (int dataSetIndex = localDataSetList.size() - 1; dataSetIndex >= 0; dataSetIndex--) {
             final DataSet dataSet = localDataSetList.get(dataSetIndex);
+            if (!dataSet.isVisible()) {
+                continue;
+            }
             dataSet.lock().readLockGuard(() -> {
                 // check for potentially reduced data range we are supposed to plot
                 final int indexMin = Math.max(0, dataSet.getIndex(DataSet.DIM_X, xMin));

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/MountainRangeRenderer.java

@@ -1,6 +1,5 @@
 package de.gsi.chart.renderer.spi;
 
-import static de.gsi.dataset.DataSet.DIM_X;
 import static de.gsi.dataset.DataSet.DIM_Y;
 import static de.gsi.dataset.DataSet.DIM_Z;
 
@@ -90,16 +89,14 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         final double zRangeMax = localDataSetList.stream().mapToDouble(ds -> ds.getAxisDescription(DIM_Z).getMax()).max().orElse(+1.0);
 
         // render in reverse order
-        List<DataSet> drawnDataSet = new ArrayList<>(localDataSetList.size());
         for (int dataSetIndex = localDataSetList.size() - 1; dataSetIndex >= 0; dataSetIndex--) {
             final DataSet dataSet = localDataSetList.get(dataSetIndex);
 
             // detect and fish-out 3D DataSet, ignore others
-            if (!(dataSet instanceof GridDataSet)) {
+            if (!dataSet.isVisible() || !(dataSet instanceof GridDataSet)) {
                 continue;
             }
 
-            drawnDataSet.add(dataSet);
             dataSet.lock().readLockGuardOptimistic(() -> {
                 xWeakIndexMap.clear();
                 yWeakIndexMap.clear();
@@ -127,7 +124,7 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         }
 
         ProcessingProfiler.getTimeDiff(start);
-        return drawnDataSet;
+        return localDataSetList;
     }
 
     /**
@@ -308,6 +305,16 @@ public DataSet set(final DataSet other, final boolean copy) {
             throw new UnsupportedOperationException("copy setter not implemented for Demux3dTo2dDataSet");
         }
 
+        @Override
+        public boolean isVisible() {
+            return dataSet.isVisible();
+        }
+
+        @Override
+        public DataSet setVisible(boolean visible) {
+            return dataSet.setVisible(visible);
+        }
+
         @Override
         public List<EventListener> updateEventListener() {
             return updateListener;

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/ReducingLineRenderer.java

@@ -77,8 +77,10 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         final double xmin = xAxis.getValueForDisplay(0);
         final double xmax = xAxis.getValueForDisplay(xAxisWidth);
         int index = 0;
-        List<DataSet> drawnDataSet = new ArrayList<>(localDataSetList.size());
         for (final DataSet ds : localDataSetList) {
+            if (!ds.isVisible()) {
+                continue;
+            }
             final int lindex = index;
             ds.lock().readLockGuardOptimistic(() -> {
                 // update categories in case of category axes for the first
@@ -159,7 +161,7 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         }
         ProcessingProfiler.getTimeDiff(start);
 
-        return drawnDataSet;
+        return localDataSetList;
     }
 
     public void setMaxPoints(final int maxPoints) {

chartfx-chart/src/main/java/de/gsi/chart/renderer/spi/financial/CandleStickRenderer.java

@@ -138,7 +138,7 @@ public List<DataSet> render(final GraphicsContext gc, final Chart chart, final i
         var index = 0;
 
         for (final DataSet ds : localDataSetList) {
-            if (ds.getDimension() < 7)
+            if (!ds.isVisible() || ds.getDimension() < 7)
                 continue;
             final int lindex = index;