Custom Controls

Shows how to create custom controls.

This example creates a "rotate to north" button.

<!DOCTYPE html>
<html>
  <head>
    <title>Custom Controls</title>
    <link rel="stylesheet" href="https://openlayers.org/en/v5.3.0/css/ol.css" type="text/css">
    <!-- The line below is only needed for old environments like Internet Explorer and Android 4.x -->
    <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=requestAnimationFrame,Element.prototype.classList,URL"></script>

    <style>
      .rotate-north {
        top: 65px;
        left: .5em;
      }
      .ol-touch .rotate-north {
        top: 80px;
      }
    </style>
  </head>
  <body>
    <div id="map" class="map"></div>
    <script>
      import Map from 'ol/Map.js';
      import View from 'ol/View.js';
      import {defaults as defaultControls, Control} from 'ol/control.js';
      import TileLayer from 'ol/layer/Tile.js';
      import OSM from 'ol/source/OSM.js';


      //
      // Define rotate to north control.
      //


      /**
       * @constructor
       * @extends {module:ol/control/Control~Control}
       * @param {Object=} opt_options Control options.
       */
      var RotateNorthControl = (function (Control) {
        function RotateNorthControl(opt_options) {
          var options = opt_options || {};

          var button = document.createElement('button');
          button.innerHTML = 'N';

          var element = document.createElement('div');
          element.className = 'rotate-north ol-unselectable ol-control';
          element.appendChild(button);

          Control.call(this, {
            element: element,
            target: options.target
          });

          button.addEventListener('click', this.handleRotateNorth.bind(this), false);
        }

        if ( Control ) RotateNorthControl.__proto__ = Control;
        RotateNorthControl.prototype = Object.create( Control && Control.prototype );
        RotateNorthControl.prototype.constructor = RotateNorthControl;

        RotateNorthControl.prototype.handleRotateNorth = function handleRotateNorth () {
          this.getMap().getView().setRotation(0);
        };

        return RotateNorthControl;
      }(Control));


      //
      // Create map, giving it a rotate to north control.
      //


      var map = new Map({
        controls: defaultControls().extend([
          new RotateNorthControl()
        ]),
        layers: [
          new TileLayer({
            source: new OSM()
          })
        ],
        target: 'map',
        view: new View({
          center: [0, 0],
          zoom: 3,
          rotation: 1
        })
      });
    </script>
  </body>
</html>