forked from Snck3rs/contao-leaflet-libraries
Add fullscreen control libs.
This commit is contained in:
68
assets/leaflet-fullscreen/README.md
Normal file
68
assets/leaflet-fullscreen/README.md
Normal file
@@ -0,0 +1,68 @@
|
||||
Leaflet.Control.FullScreen
|
||||
============
|
||||
|
||||
What ?
|
||||
------
|
||||
|
||||
Simple plugin for Leaflet that adds fullscreen button to your maps.
|
||||
|
||||
Inspired by http://elidupuis.github.com/leaflet.zoomfs/
|
||||
|
||||
Use the native javascript fullscreen API http://johndyer.name/native-fullscreen-javascript-api-plus-jquery-plugin/
|
||||
|
||||
Released under the MIT License http://opensource.org/licenses/mit-license.php
|
||||
|
||||
How ?
|
||||
------
|
||||
|
||||
Include Control.FullScreen.js and Control.FullScreen.css in your page:
|
||||
|
||||
``` html
|
||||
<link rel="stylesheet" href="Control.FullScreen.css" />
|
||||
<script src="Control.FullScreen.js"></script>
|
||||
```
|
||||
|
||||
Add the fullscreen control to the map:
|
||||
|
||||
``` js
|
||||
var map = new L.Map('map', {
|
||||
fullscreenControl: true,
|
||||
fullscreenControlOptions: {
|
||||
position: 'topleft'
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
If your map have a zoomControl the fullscreen button will be added at the bottom of this one.
|
||||
|
||||
If your map doesn't have a zoomContron the fullscreen button will be added to topleft corner of the map (same as the zoomcontrol).
|
||||
|
||||
__Events and options__:
|
||||
|
||||
``` js
|
||||
// create a fullscreen button and add it to the map
|
||||
L.control.fullscreen({
|
||||
position: 'topleft', // change the position of the button can be topleft, topright, bottomright or bottomleft, defaut topleft
|
||||
title: 'Show me the fullscreen !', // change the title of the button, default Full Screen
|
||||
forceSeparateButton: true, // force seperate button to detach from zoom buttons, default false
|
||||
forcePseudoFullscreen: true // force use of pseudo full screen even if full screen API is available, default false
|
||||
}).addTo(map);
|
||||
|
||||
// events are fired when entering or exiting fullscreen.
|
||||
map.on('enterFullscreen', function(){
|
||||
console.log('entered fullscreen');
|
||||
});
|
||||
|
||||
map.on('exitFullscreen', function(){
|
||||
console.log('exited fullscreen');
|
||||
});
|
||||
```
|
||||
|
||||
Where ?
|
||||
------
|
||||
|
||||
Source code : https://github.com/brunob/leaflet.fullscreen
|
||||
|
||||
Downloads : https://github.com/brunob/leaflet.fullscreen/releases
|
||||
|
||||
Demo : http://brunob.github.com/leaflet.fullscreen/
|
||||
Reference in New Issue
Block a user