Maps SDK for Web - ttPlugins.Minimap

tt.plugins.Minimap

This plugin provides a minimap functionality to your map.

To see the plugin in action, visit: Minimap example

Minimap.css - CSS declarations for Minimap plugin. Without this stylesheet, dependant elements might appear in wrong place. It can be imported:

in the <head> of your HTML document:
<link rel='stylesheet' type='text/css' href='https://api.tomtom.com/maps-sdk-for-web/cdn/plugins/Minimap/<version>/Minimap.css'>
or if you're using Webpack with css-loader:
import '@tomtom-international/web-sdk-plugin-minimap/dist/Minimap.css';

To find current plugin's version, visit the Downloads page.

{
   ttMapsSdk: tt,
   ignorePitchAndBearing: true,
   zoomOffset: 5,
   mapOptions: {
       key: <your-api-key>,
       dragRotate: false
   }
}

Name	Description
options Required Object default:None	The Options object.
options.ttMapsSdk Required Object default:None	TomTom Maps SDK.
options.mapOptions Required Object default:None	Map options.
options.mapOptions.key Required Object default:None	Map key
options.mapOptions.style Required Object default:None	Map style.
options.zoomOffset Number default:5	Zoom offset. Minimum value is 3.
options.ignorePitchAndBearing Number default:false	When applied,
options.cssStyleCheck Boolean default:true	If true, the plugin will check if required css styles are added. pitch and bearing changes won't affect the parent map.

Returns a map instance created for the use of this plugin.

Map An instance of a map.

Binds the map with the plugin instance.

Name	Description
map Required Maps.Map default:None

Removes the plugin from the map.

Void