Restrict the map view area

Open in CodeSandbox

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
    <script crossorigin src="https://cdn.jsdelivr.net/npm/@babel/standalone@7/babel.min.js"></script>
    <!-- To make the map appear, you must add your apikey -->
    <script src="https://js.api.mappable.world/v3/?apikey=<YOUR_APIKEY>&lang=en_US" type="text/javascript"></script>

    <script
      data-plugins="transform-modules-umd"
      data-presets="typescript"
      type="text/babel"
      src="../variables.ts"
    ></script>
    <script
      data-plugins="transform-modules-umd"
      data-presets="typescript"
      type="text/babel"
      src="./common.ts"
    ></script>
    <script data-plugins="transform-modules-umd" data-presets="typescript" type="text/babel">
      import {RESTRICTION_TOOLTIP_TEXT} from './common';
      import {POLYGON_COORDINATES, RESTRICT_AREA, ZOOM_RANGE} from '../variables';

      window.map = null;

      main();

      async function main() {
          // Waiting for all api elements to be loaded
          await mappable.ready;
          const {MMap, MMapDefaultSchemeLayer, MMapDefaultFeaturesLayer, MMapFeature, MMapControls, MMapComplexEntity} =
              mappable;
          // Initialize the map
          map = new MMap(
              // Pass the link to the HTMLElement of the container
              document.getElementById('app'),
              // Pass the map initialization parameters, set the map location bounds with the current restricted area
              {
                  location: {bounds: RESTRICT_AREA},
                  restrictMapArea: RESTRICT_AREA,
                  zoomRange: ZOOM_RANGE
              },
              // Add a map schema layer and a geo objects layer
              [new MMapDefaultSchemeLayer({}), new MMapDefaultFeaturesLayer({})]
          );

          // Create and add a polygon to the map that will mark the border of the map restrict area
          const borderPolygon = new MMapFeature({
              id: 'polygon',
              geometry: {
                  type: 'Polygon',
                  coordinates: [POLYGON_COORDINATES]
              },
              style: {
                  stroke: [{width: 12, color: '#122DB2'}],
                  fill: 'rgba(0, 0, 0, 0)'
              }
          });
          map.addChild(borderPolygon);

          class RestrictionTooltip extends MMapComplexEntity<{}> {
              private _element: HTMLDivElement;

              private _detachDom: () => void;

              // Method for create a DOM control element
              _createElement() {
                  const tooltipElement = document.createElement('div');

                  tooltipElement.innerHTML = RESTRICTION_TOOLTIP_TEXT;
                  tooltipElement.classList.add('restriction_tooltip');
                  return tooltipElement;
              }

              // Method for attaching the control to the map
              _onAttach() {
                  this._element = this._createElement();
                  this._detachDom = mappable.useDomContext(this, this._element, this._element);
              }

              // Method for detaching control from the map
              _onDetach() {
                  this._detachDom();
                  this._detachDom = null;
                  this._element = null;
              }
          }

          const tooltip = new RestrictionTooltip({});

          // Add a container for MMapControlButton and add it to the map
          const controls = new MMapControls({position: 'top left'});
          controls.addChild(tooltip);
          map.addChild(controls);
      }
    </script>

    <!-- prettier-ignore -->
    <style> html, body, #app { width: 100%; height: 100%; margin: 0; padding: 0; font-family: Arial, Helvetica, sans-serif; } .toolbar { position: absolute; z-index: 1000; top: 0; left: 0; display: flex; align-items: center; padding: 16px; } .toolbar a { padding: 16px; }  </style>
    <link rel="stylesheet" href="./common.css" />
    <link rel="stylesheet" href="../variables.css" />
  </head>
  <body>
    <div id="app"></div>
  </body>
</html>
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
    <script crossorigin src="https://cdn.jsdelivr.net/npm/react@17/umd/react.production.min.js"></script>
    <script crossorigin src="https://cdn.jsdelivr.net/npm/react-dom@17/umd/react-dom.production.min.js"></script>
    <script crossorigin src="https://cdn.jsdelivr.net/npm/@babel/standalone@7/babel.min.js"></script>
    <!-- To make the map appear, you must add your apikey -->
    <script src="https://js.api.mappable.world/v3/?apikey=<YOUR_APIKEY>&lang=en_US" type="text/javascript"></script>

    <script
      data-plugins="transform-modules-umd"
      data-presets="typescript"
      type="text/babel"
      src="../variables.ts"
    ></script>
    <script
      data-plugins="transform-modules-umd"
      data-presets="typescript"
      type="text/babel"
      src="./common.ts"
    ></script>
    <script data-plugins="transform-modules-umd" data-presets="react, typescript" type="text/babel">
      import {RESTRICTION_TOOLTIP_TEXT} from './common';
      import {POLYGON_COORDINATES, RESTRICT_AREA, ZOOM_RANGE} from '../variables';

      window.map = null;

      main();

      async function main() {
        // For each object in the JS API, there is a React counterpart
        // To use the React version of the API, include the module @mappable-world/mappable-reactify
        const [mappableReact] = await Promise.all([
          mappable.import('@mappable-world/mappable-reactify'),
          mappable.ready
        ]);
        const reactify = mappableReact.reactify.bindTo(React, ReactDOM);
        const {MMap, MMapDefaultSchemeLayer, MMapDefaultFeaturesLayer, MMapFeature, MMapControls, MMapControl} =
          reactify.module(mappable);

        function App() {
          return (
            // Initialize the map and pass initialization parameters, set the map location bounds with the current restricted area
            <MMap
              location={{bounds: RESTRICT_AREA}}
              restrictMapArea={RESTRICT_AREA}
              zoomRange={ZOOM_RANGE}
              ref={(x) => (map = x)}
            >
              {/* Add a map schema layer and a geo objects layer */}
              <MMapDefaultSchemeLayer />
              <MMapDefaultFeaturesLayer />

              {/* Add a polygon to the map that will mark the border of the map restrict area */}
              <MMapFeature
                geometry={{
                  type: 'Polygon',
                  coordinates: [POLYGON_COORDINATES]
                }}
                style={{
                  stroke: [{width: 12, color: '#122DB2'}],
                  fill: 'rgba(0, 0, 0, 0)'
                }}
              />

              {/* Add MMapControlButton that changes the restricted area */}
              <MMapControls position="top left">
                <MMapControl transparent>
                  <div
                    className="restriction_tooltip"
                    dangerouslySetInnerHTML={{__html: RESTRICTION_TOOLTIP_TEXT}}
                  ></div>
                </MMapControl>
              </MMapControls>
            </MMap>
          );
        }

        ReactDOM.render(
          <React.StrictMode>
            <App />
          </React.StrictMode>,
          document.getElementById('app')
        );
      }
    </script>

    <!-- prettier-ignore -->
    <style> html, body, #app { width: 100%; height: 100%; margin: 0; padding: 0; font-family: Arial, Helvetica, sans-serif; } .toolbar { position: absolute; z-index: 1000; top: 0; left: 0; display: flex; align-items: center; padding: 16px; } .toolbar a { padding: 16px; }  </style>
    <link rel="stylesheet" href="./common.css" />
    <link rel="stylesheet" href="../variables.css" />
  </head>
  <body>
    <div id="app"></div>
  </body>
</html>
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
    <script crossorigin src="https://cdn.jsdelivr.net/npm/vue@3/dist/vue.global.js"></script>
    <script crossorigin src="https://cdn.jsdelivr.net/npm/@babel/standalone@7/babel.min.js"></script>
    <!-- To make the map appear, you must add your apikey -->
    <script src="https://js.api.mappable.world/v3/?apikey=<YOUR_APIKEY>&lang=en_US" type="text/javascript"></script>

    <script
      data-plugins="transform-modules-umd"
      data-presets="typescript"
      type="text/babel"
      src="../variables.ts"
    ></script>
    <script
      data-plugins="transform-modules-umd"
      data-presets="typescript"
      type="text/babel"
      src="./common.ts"
    ></script>
    <script data-plugins="transform-modules-umd" data-presets="typescript" type="text/babel">
      import {RESTRICTION_TOOLTIP_TEXT} from './common';
      import {POLYGON_COORDINATES, RESTRICT_AREA, ZOOM_RANGE} from '../variables';

      window.map = null;

      async function main() {
        // For each object in the JS API, there is a Vue counterpart
        // To use the Vue version of the API, include the module @mappable-world/mappable-vuefy
        const [mappableVue] = await Promise.all([mappable.import('@mappable-world/mappable-vuefy'), mappable.ready]);
        const vuefy = mappableVue.vuefy.bindTo(Vue);
        const {MMap, MMapDefaultSchemeLayer, MMapDefaultFeaturesLayer, MMapFeature, MMapControls, MMapControl} =
          vuefy.module(mappable);

        const App = Vue.createApp({
          components: {
            MMap,
            MMapDefaultSchemeLayer,
            MMapDefaultFeaturesLayer,
            MMapFeature,
            MMapControls,
            MMapControl
          },
          setup() {
            const refMap = (ref) => {
              window.map = ref?.entity;
            };

            return {RESTRICTION_TOOLTIP_TEXT, refMap, RESTRICT_AREA, ZOOM_RANGE, POLYGON_COORDINATES};
          },
          template: `
      <MMap
        :location="{ bounds: RESTRICT_AREA }"
        :restrictMapArea="RESTRICT_AREA"
        :zoomRange="ZOOM_RANGE"
        :ref="refMap"
      >
        <MMapDefaultSchemeLayer />
        <MMapDefaultFeaturesLayer />
        <MMapFeature
          :geometry="{
            type: 'Polygon',
            coordinates: [POLYGON_COORDINATES]
          }"
          :style="{
            stroke: [{ width: 12, color: '#122DB2' }],
            fill: 'rgba(0, 0, 0, 0)'
          }"
        />
        <MMapControls position="top left">
          <MMapControl :transparent="true">
            <div class="restriction_tooltip" v-html="RESTRICTION_TOOLTIP_TEXT"></div>
          </MMapControl>
        </MMapControls>
      </MMap>
    `
        });
        App.mount('#app');
      }

      main();
    </script>

    <!-- prettier-ignore -->
    <style> html, body, #app { width: 100%; height: 100%; margin: 0; padding: 0; font-family: Arial, Helvetica, sans-serif; } .toolbar { position: absolute; z-index: 1000; top: 0; left: 0; display: flex; align-items: center; padding: 16px; } .toolbar a { padding: 16px; }  </style>
    <link rel="stylesheet" href="./common.css" />
    <link rel="stylesheet" href="../variables.css" />
  </head>
  <body>
    <div id="app"></div>
  </body>
</html>
.restriction_tooltip {
  padding: 8px 12px 8px 32px;
  border-radius: 12px;
  background-color: #313133;
  background-image: url('./info-icon.svg');
  background-position: 2% 20%;
  background-repeat: no-repeat;
  gap: 8px;
  color: #f2f5fa;
  font-size: 14px;
  line-height: 20px;
}
import {ZOOM_RANGE} from './variables';

export const RESTRICTION_TOOLTIP_TEXT = `There is restriction over ${ZOOM_RANGE.min.toFixed()} zoom. <br/> To see border of restriction area move to sides.`;
:root {
}
import type {LngLat, LngLatBounds, ZoomRange} from '@mappable-world/mappable-types';

// Bounding box - bottom left and top right corners
export const RESTRICT_AREA: LngLatBounds = [
  [54.0182, 24.2969],
  [54.6774, 24.5939]
];

export const POLYGON_COORDINATES: LngLat[] = [
  RESTRICT_AREA[0],
  [RESTRICT_AREA[1][0], RESTRICT_AREA[0][1]],
  RESTRICT_AREA[1],
  [RESTRICT_AREA[0][0], RESTRICT_AREA[1][1]]
];

export const ZOOM_RANGE: ZoomRange = {min: 12, max: 22};