Additional Control methods (#1295) (minor)

* extra custom control methods

- adds `buttonExists(name: string)` to get the status of a button
- adds `getCustomButtons()` that returns an object of all of the custom controls
- ts definitions

* docs

* fix: suggestions

* fix: add some very basic tests

* Apply suggestions from code review

* Update src/js/Toolbar/L.PM.Toolbar.js

---------

Co-authored-by: Florian Bischof <[email protected]>

cypress/integration/toolbar.spec.js

@@ -218,6 +218,11 @@ describe('Testing the Toolbar', () => {
         expect(testresult).to.equal('clickButton clicked');
         cy.get(container).should('not.have.class', 'active');
       });
+      expect(map.pm.Toolbar.getButton('clickButton')).to.not.equal(undefined);
+      expect(map.pm.Toolbar.controlExists('clickButton')).to.equal(true);
+      expect(
+        'clickButton' in map.pm.Toolbar.getButtonsInBlock('custom')
+      ).to.equal(true);
     });
   });
 

leaflet-geoman.d.ts

@@ -666,6 +666,18 @@ declare module 'leaflet' {
         position: L.ControlPosition
       ): void;
 
+      /** Returns all of the active buttons */
+      getButtons(): Record<string, L.Control>
+
+      /** Returns the full button object or undefined if the name does not exist */
+      getButton(name: string): L.Control | undefined;
+
+      /** Checks whether a button has been mounted */
+      controlExists(name: string): boolean;
+
+      /** Returns all of the custom, active buttons */
+      getButtonsInBlock(name: string): Record<string, L.Control>
+
       /** Returns a Object with the positions for all blocks */
       getBlockPositions(): BlockPositions;
 

src/js/Toolbar/L.PM.Toolbar.js

@@ -563,7 +563,28 @@ const Toolbar = L.Class.extend({
     this.changeControlOrder();
     return control;
   },
-
+  controlExists(name) {
+    return Boolean(this.getButton(name));
+  },
+  getButton(name) {
+    return this.getButtons()[name];
+  },
+  getButtonsInBlock(name) {
+    const buttonsInBlock = {};
+    if (name) {
+      for (const buttonName in this.getButtons()) {
+        const button = this.getButtons()[buttonName];
+        // draw controls doesn't have a block
+        if (
+          button._button.tool === name ||
+          (name === 'draw' && !button._button.tool)
+        ) {
+          buttonsInBlock[buttonName] = button;
+        }
+      }
+    }
+    return buttonsInBlock;
+  },
   changeControlOrder(order = []) {
     const shapeMapping = this._shapeMapping();