# gpan

> Node.js module to download hi-res streetview panoramas

Latest version **1.2.1** (published 2013-03-07) · 0 weekly downloads

## Install

```sh
npm install gpan
pnpm add gpan
yarn add gpan
bun add gpan
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2013-03-07 |
| First published | 2013-03-06 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 0.8.x |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | mediamagic israel |
| Maintainers | djabor |
| Keywords | panorama, streetview, google |

## Links

- npm: https://www.npmjs.com/package/gpan
- Repository: https://github.com/mediamagic/gpan
- Issues: https://github.com/mediamagic/gpan/issues
- npm.io page: https://npm.io/package/gpan

## Dependencies (1)

- [temp](https://npm.io/package/temp.md) 0.5.x

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2013-03-07
- 1.2.0 — 2013-03-06
- 1.1.1 — 2013-03-06
- 1.1.0 — 2013-03-06

## README

# Google Panorama Montage

Download high resolution Google Streetview panorama images and stitch them together into a large panorama image

## Version
`1.2.1`

## Installation

`npm install gpan`

## Dependencies

This application depends on imagemagick and uses the montage binary to create a large image
from the separate image files downloaded via google api

## Disclaimer

This application makes use of an onducumented Google Maps API. While you may access them, there is no
guarantee that this API will not change in the future revisions to Google Maps.

## Changes
* Changes in 1.2.1
	* fixed an issue where the montage would try to build the montage before all tiles were downloaded
* Changes in 1.2.0
    * `init()` and `set()` have merged into a single method `.config()`
    * `savePanorama()` now accepts a single pano_id or an array of pano_id's
    * gpan will now handle temporary files internally
    * gpan now depends on the `node-temp` library
* Fixes in 1.2.0
    * google cbk(x) api call are made to random numbers (0-4) to spread load
    * errors on google cbk calls will bubble up.

## Example usage

```js
var gp = require("gpan")

//all settings are optional and default to the shown values
gp.config({ zoom_level:0				//panorama zoom level, default 0
		, tiles_prefix:'image_'			//tile image prefix, useful for montage
		, path_to_image:'panos'			//panorama will create this folder and store the panorama in it
		, output_prefix:'output_'		//prefix for the panorama image
		, tmp_dir_prefix: 'gpan_tmp'	//temp folder prefix
		, pub: true						// path_to_image relative to app root or public folder
		})

//each setting can be changed separately
gp.config('zoom_level', 3);

//each setting value can be returned
var zoom = gp.config('zoom_level') // returns 3

//retrieve panorama image for Times Square, New York
gp.savePanorama('3q57BxQpP8dNzwD0R5PIzg', function(err,path){
	if(err)
		return handleError(err);
	console.log(path); //will return the full path to the panorama image
});
```

## License

Copyright (c) 2013 M.M. Alcobs LTD  licensed under the GNU GPL License
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

---
_Source: https://npm.io/package/gpan · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
