Maps SDK for Web

tt.plugins.Minimap

This plugin provides a minimap functionality to your map.

To see the plugin in action, visit: Minimap example

Constructor

tt.plugins.Minimap(options)

Example
{
   ttMapsSdk: tt.map,
   ignorePitchAndBearing: true,
   zoomOffset: 5,
   mapOptions: {
       key: <your-api-key>,
       style: 'tomtom://vector/1/basic-main',
       dragRotate: false
   }
}
Parameters
Name Description
options
Object
default:None
The Options object.
options.ttMapsSdk
Object
default:None
TomTom Maps SDK.
options.mapOptions
Object
default:None
Map options.
options.mapOptions.key
Object
default:None
Map key
options.mapOptions.style
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.

Methods

getMap( ): Maps.Map

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

Returns

An instance of a map.