Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

wrld.js

0.1.1873 • Public • Published

wrld.js

WRLD

The WRLD JavaScript API allows you to easily embed beautiful 3D maps into any web page for any modern, WebGL supporting browser. For an example of our 3D maps in action, see https://www.wrld3d.com/wrld.js/examples/.

It is based on Leaflet.js, providing a familiar API for embedding 3D maps in a web page.

Examples

You can find feature-by-feature examples on our website.

API

A full API reference is also available on our website.

Getting Started

Before you begin, you will need to acquire an API key, which you can do by signing up for a free account at wrld3d.com.

You can easily embed a 3D map in any web page. The code below shows a simple example:

<!-- Create a map in an HTML element with wrld.js -->
<!DOCTYPE HTML>
<html>
  <head>
    <script src="https://cdn-webgl.wrld3d.com/wrldjs/dist/latest/wrld.js"></script> 
    <link href="https://cdnjs.cloudflare.com/ajax/libs/leaflet/1.0.1/leaflet.css" rel="stylesheet" />
  </head>
  <body>
    <div id="map" style="width: 400px; height: 400px;"></div>
    <script type="text/javascript">
      var map = L.Wrld.map("map", "your_api_key_here");
    </script> 
  </body>
</html>

Just replace your_api_key_here with an API key from wrld3d.com.

Support

If you have any questions, bug reports, or feature requests, feel free to submit to the issue tracker for wrld.js on GitHub.

Building the API

You may wish to build the API yourself. This is easy to do and only requires that you install node.js.

Requirements

  • Node.js (v4.4.1 tested)
  • npm (installed with Node.js)

Building

Follow the steps below to build the API:

  1. Clone this repo: git clone https://github.com/wrld3d/wrld.js.git
  2. In the root of the repo, run npm install to install the development dependencies.
  3. Still in the root of the repo, run the command npm run build.

This will create the files dist/wrld.js and dist/wrld.min.js which are the API and the minified form respectively.

You can also use the command npm run watch to build continuously, watching files for changes.

Contributing

If you wish to contribute to this repo, pull requests on GitHub are welcomed.

License

The WRLD 3D Maps JavaScript API is released under the Simplified BSD License. See LICENSE.md for details.

Keywords

none

install

npm i wrld.js

Downloadsweekly downloads

3,000

version

0.1.1873

license

See license in LICENSE.md

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability