feat!: add Breadcrumbs to PlotOptionsTreemap (#7970)

DiegoCardoso · web-flow · commit b6a0aeb08f24 · 2025-09-10T16:54:11.000+02:00
* feat: add `Breadcrumbs` API to `Drilldown` in charts

Add the API related to configuring the breadcrumbs API added to replace
the drillup button and mark the API related to `DrillUpButton` as
deprecated.

* refactor: use the new ButtonRelativeTo enum

* refactor!: mark methods in Lang as deprecated

* refactor!: add deprecated annotation

* feat: add `Breadcrumbs` to `PlotOptionsTreemap`

Also add `allowTraverseUp` property, replacing `allowDrillToNode`

* refactor: initialize breadcrumbs if null on getter
diff --git a/vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/PlotOptionsTreemap.java b/vaadin-charts-flow-parent/vaadin-charts-flow/src/main/java/com/vaadin/flow/component/charts/model/PlotOptionsTreemap.java
@@ -23,6 +23,8 @@
 public class PlotOptionsTreemap extends AbstractPlotOptions {
 
     private Boolean allowDrillToNode;
+    private Breadcrumbs breadcrumbs;
+    private Boolean allowTraversingTree;
     private Boolean allowPointSelect;
     private Boolean alternateStartingDirection;
     private Boolean animation;
@@ -78,7 +80,9 @@ public ChartType getChartType() {
 
     /**
      * @see #setAllowDrillToNode(Boolean)
+     * @deprecated Use {@link #setAllowTraversingTree(Boolean)} instead.
      */
+    @Deprecated(since = "25.0", forRemoval = true)
     public Boolean getAllowDrillToNode() {
         return allowDrillToNode;
     }
@@ -88,7 +92,10 @@ public Boolean getAllowDrillToNode() {
      * on its children.
      * <p>
      * Defaults to: false
+     *
+     * @deprecated Use {@link #setAllowTraversingTree(Boolean)} instead.
      */
+    @Deprecated(since = "25.0", forRemoval = true)
     public void setAllowDrillToNode(Boolean allowDrillToNode) {
         this.allowDrillToNode = allowDrillToNode;
     }
@@ -110,6 +117,24 @@ public void setAllowPointSelect(Boolean allowPointSelect) {
         this.allowPointSelect = allowPointSelect;
     }
 
+    /**
+     * {@see #setAllowTraversingTree(Boolean)}
+     */
+    public Boolean getAllowTraversingTree() {
+
+        return allowTraversingTree;
+    }
+
+    /**
+     * When enabled the user can click on a point which is a parent and zoom in
+     * on its children.
+     * <p>
+     * Defaults to: false
+     */
+    public void setAllowTraversingTree(Boolean allowTraversingTree) {
+        this.allowTraversingTree = allowTraversingTree;
+    }
+
     /**
      * @see #setAlternateStartingDirection(Boolean)
      */
@@ -205,6 +230,26 @@ public void setBorderWidth(Number borderWidth) {
         this.borderWidth = borderWidth;
     }
 
+    /**
+     * {@see #setBreadcrumbs(Breadcrumbs)}
+     */
+    public Breadcrumbs getBreadcrumbs() {
+        if (breadcrumbs == null) {
+            breadcrumbs = new Breadcrumbs();
+        }
+        return breadcrumbs;
+    }
+
+    /**
+     * Options for the breadcrumbs, the navigation at the top leading the way up
+     * through the traversed levels.
+     * 
+     * @param breadcrumbs
+     */
+    public void setBreadcrumbs(Breadcrumbs breadcrumbs) {
+        this.breadcrumbs = breadcrumbs;
+    }
+
     /**
      * @see #setClassName(String)
      */
