Code Monkey home page Code Monkey logo

leaflet.export's Introduction

Leaflet.Export

Additional methods to L.map class provides export and print maps

API

The following methods are added to the class:

  • export(exportOptions) - create a map canvas or image in a specified format;
  • downloadExport(downloadOptions) - save map image to specified file;
  • printExport(printOptions) - print map image;
  • supportedCanvasMimeTypes() - generates a list of supported images formats for canvas.

export(exportOptions)

Method export create a map canvas or image in a specified format. Returned value - promise.

The conversion process consists of two stages (steps in promise chain):

  • rendering maps canvas;
  • export canvas to the specified format.

Options:

  • format:
    • image/png, image/jpeg, image/jpg, image/gif, image/bmp, image/tiff, image/x-icon, image/svg+xml, image/webp - return image in specified mime format.
    • Developer can obtain list of the supported format by using the method supportedCanvasMimeTypes()
  • caption:
    • text - header content (e.g. 'Map of Perm');
    • font - font size and style (e.g. '30px Arial');
    • fillStyle - filled color (e.g. 'blue');
    • position - position in pixels of upper left corner of header (e.g.'10,100).
  • exclude - list of items are not displayed on the map when exporting, can contain in any order next values:
    • excluded DOM-element;
    • text selector for excluded elements in DOM-format: .selectedClassOfDomElements, #elementId;
    • text selector for excluded elements in JQuery format: $(selector).
  • afterRender - function to be called after the rendering stage. The function may be additional processing the canvas or perform other actions before second stage (export canvas to image):
    • param: canvas;
    • template:
    afterRender(canvas) {
      operators...;
      return canvas;
    }
  • afterExport - function to be called after export map;
    • param: dataURL;
    • template:
    afterExport(dataURL) {
      operators...;
      return dataURL;
    }
  • logging - default: false :
    • true, false

downloadExport(downloadOptions)

Method downloadExport() calls the method export() to form the map image and stores the image in the specified file. In addition to the options of the method export(), method downloadExport() supports option fileName. For several images download, downloadOptions must be an array.

printExport(printOptions)

Method printExport() calls the method export() to form the map image prints the image. Methods options consistent with the options of the method export(). For several images print, printOptions must be an array.

leaflet.export's People

Contributors

almostcake avatar dubrovinpavel avatar iredmedia avatar magamig avatar seregamatin avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.