Giter VIP home page Giter VIP logo

picomap's Introduction

A minimal web map client

Picomap is a hyperminimalist map client without any dependencies written in native JS. The source code for the project is in the ./src directory

How to use the map

Add a div in your project with id="map". In addition add the following script to your project: <script src="https://unpkg.com/picomap/dist/picomap.js"></script>

Minimal example

index.html:

<!DOCTYPE html>
<html lang="en">
  <head>
  </head>
  <body>
    <div id="map"></div>
    <script src="https://unpkg.com/picomap/dist/picomap.js"></script>
    <script src="./index.js"></script>
  </body>
</html>

index.js:

const mapInstance = new Picomap();
mapInstance.initialize();

Picomap accepts the following attributes, none of which are required:

Name Type Default Value Accepted values Description
height number 500 Height of the map
width number 500 Width of the map
lat number 60.5 -85.06-85.06 Latitude for the map centre
lon number 24.4391 -180-180 Longitude for the map centre
zoom number 10 0-19 Initial zoom level
id string "map" Id of the map's div
source string "https://tile.openstreetmap.org" Source for the raster tiles

Building from source

  1. Clone the git library: https://github.com/leoalho/picomap.git
  2. Install dependecies: npm install
  3. Build the files: npm run build
    This will build three different files to to ./dist directory. picomap.max.js for the bundles cjs file, picomap-es.js for the bundled es file and picomap.js for the minimized cjs file. In addition source maps are created for each file.

Using with npm

The library is possible to install with npm by running npm install picomap. The files for the library are as specified in the las section. Both ES import and CommonJS require syntax should work.

picomap's People

Contributors

leoalho avatar

Stargazers

Andres Herrera avatar

Watchers

 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.