leaflet-easyPrint
A simple leaflet plugin which adds an icon to print or export a map.
Features
- Supports resizing to predefined sizes (A4 Landscape & Portrait) as well as custom sizes
- Supports saving to png, as well as printing
- Compatible with both Leaflet v1+ and 0.7
- Tested on Chrome, Firefox
- Incompatible with IE & Edge due to
dom-to-image
dependency
- Incompatible with IE & Edge due to
Check out the demo.
Download
You can either download this repo directly or install via NPM.
npm install leaflet-easyprint
Options
You can pass a number of options to the plugin to control various settings.
Option | Type | Default | Description |
---|---|---|---|
title | string | 'Print map' | Sets the text which appears as the tooltip of the print/export button |
position | Leaflet control position | 'topleft' | Positions the print button |
sizeModes | array | Current |
Options available include Current , A4Portrait , A4Landscape or a custom size object |
defaultSizeTitles | object | {Current: 'Current Size', A4Landscape: 'A4 Landscape', A4Portrait: 'A4 Portrait'} |
button tooltips for the default page sizes |
exportOnly | Boolean | false |
If set to true the map is exported to a png file |
tileLayer | Leaflet tile layer | null |
A tile layer that you can wait for to draw (helpful when resizing) |
tileWait | Integer | 500 | How long to wait for the tiles to draw (helpful when resizing) |
filename | string | 'map' | Name of the file if export only option set to true |
hidden | Boolean | false | Set to true if you don't want to display the toolbar. Instead you can create your own buttons or fire print events programmatically. You still need to call addTo(map) to set the leaflet map context. |
hideControlContainer | Boolean | true | Hides the leaflet controls like the zoom buttons and the attribution on the print out. |
hideClasses | array | [] | Hides classes on the print out. Use an array of strings as follow : ['div1', 'div2'] |
customWindowTitle | string | Defaults to title of map window. | A title for the print window which will get added the printed paper. |
spinnerBgColor | string | '#0DC5C1' | A valid css colour for the spinner background color. |
customSpinnerClass | string | 'epLoader' | A class for a custom css spinner to use while waiting for the print. |
Example
L.easyPrint({
title: 'My awesome print button',
position: 'bottomright',
sizeModes: ['A4Portrait', 'A4Landscape']
}).addTo(map);
Methods / Using programmatically
Method | Options | Description |
---|---|---|
printMap(size, filename) | Print size name, either 'CurrentSize', 'A4Portrait', 'A4Landscape', or the className of a custom size. And a filename |
Manually trigger a print operation |
var printPlugin = L.easyPrint({
hidden: true,
sizeModes: ['A4Portrait']
}).addTo(map);
printPlugin.printMap('A4Portrait', 'MyFileName');
Custom Print Sizes
You can create additional print sizes by passing in some options. Width & Height are defined in pixels at 90DPI. THe css class ought to contain a background base64 encoded svg image.
var a3Size = {
width: 2339,
height: 3308,
className: 'a3CssClass',
tooltip: 'A custom A3 size'
}
// in css
.easyPrintHolder .a3CssClass {
background-image: url(data:image/svg+xml;utf8;base64,PD9...go=);
}
Acknowledgements
Huge hats off go to mourner and all the contributors to the leaflet.js project, it's an amazing piece of open source software!
Also uses dom-to-image and FileSaver under the hood.
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 记一次.NET内存居高不下排查解决与启示
· 探究高空视频全景AR技术的实现原理
· 理解Rust引用及其生命周期标识(上)
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
· 没有源码,如何修改代码逻辑?
· 分享4款.NET开源、免费、实用的商城系统
· 全程不用写代码,我用AI程序员写了一个飞机大战
· MongoDB 8.0这个新功能碉堡了,比商业数据库还牛
· 白话解读 Dapr 1.15:你的「微服务管家」又秀新绝活了
· 上周热点回顾(2.24-3.2)
2019-04-01 MapReduce、Hadoop、PostgreSQL、Spark