placard

0.1.0 • Public • Published

Placard.js

A dead simple interface for creating Google Maps with multiple points.

Usage

Begin by including the Maps API and Placard JavaScript files:

<script src="//maps.googleapis.com/maps/api/js?key=API_KEY"></script>
<script src="placard.js"></script>

Create an object containing the points you want to add to your map. The only required properties are lat and lng. Use latlng.me if you need help.

var locations = [
  {
    lat: 39.73703,
    lng: -104.97280
  },
  {
    lat: 39.76463,
    lng: -105.00401
  },
  {
    lat: 39.75046,
    lng: -104.99954
  },
  {
    lat: 39.74414,
    lng: -104.98984
  },
  {
    lat: 39.76112,
    lng: -104.98172
  }
];

Next, create a new map using Placard.Map:

var map = new Placard.Map('canvas', {
  center: {
    lat: 39.73932,
    lng: -104.98480
  },
  zoom: 13
});

Finally, add your locations to the map:

locations.forEach(function(location) {
  map.addPoint(location);
});

API

Placard.Map

Constructor

Creates a new instance of Placard.Map and returns itself.

var map = new Placard.Map(el, config);
Parameters
Name Type Description
el String The ID of the HTML element for the map
config google.maps.MapOptions The settings used to configure the map

addPoint

Adds a point to the map and returns the map.

map.addPoint(point);
Parameters
Name Type Description
point Object An object containing both lat and lng properties

Placard.Point

Constructor

Creates a new instance of Placard.Point and returns itself.

var point = new Placard.Point(point);
Parameters
Name Type Description
point Object An object containing both lat and lng properties

addToMap

Adds the point to a map and returns the point.

point.addToMap(map);
Parameters
Name Type Description
map Placard.Map The map that the point should be added to

Readme

Keywords

none

Package Sidebar

Install

npm i placard

Weekly Downloads

0

Version

0.1.0

License

MIT

Last publish

Collaborators

  • taylorsmith