feat: add ButtonRelativeTo enum; deprecate DrillUpButtonRelativeTo (#7951)

DiegoCardoso · web-flow · commit a2a798721857 · 2025-09-04T16:20:28.000+02:00
The enum values found in `DrillUpButtonRelativeTo` are useful for other types that are not related with the drill up functionallity. And since the drill up button has been deprecated in Highcharts in favor of breadcrumbs, it makes sense to create a new enum with the same values to be used in places like the reset zoom and breadcrumbs buttons. Part of #7923 Part of #7946
diff --git a/vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/ButtonRelativeTo.java b/vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/ButtonRelativeTo.java
@@ -0,0 +1,28 @@
+/**
+ * Copyright 2000-2025 Vaadin Ltd.
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
+ * license.
+ */
+package com.vaadin.flow.component.charts.model;
+
+/**
+ * What box to align the button to.
+ */
+public enum ButtonRelativeTo implements ChartEnum {
+
+    PLOTBOX("plotBox"), SPACINGBOX("spacingBox");
+
+    ButtonRelativeTo(String box) {
+        this.box = box;
+    }
+
+    private String box;
+
+    @Override
+    public String toString() {
+        return box;
+    }
+}
diff --git a/vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/DrillUpButtonRelativeTo.java b/vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/DrillUpButtonRelativeTo.java
@@ -11,6 +11,7 @@
 /**
  * What box to align the button to.
  */
+@Deprecated(since = "25.0", forRemoval = true)
 public enum DrillUpButtonRelativeTo implements ChartEnum {
 
     PLOTBOX("plotBox"), SPACINGBOX("spacingBox");
