# @carto/zera

> Grid json client for `Leaflet` and `Google Maps`.

Latest version **1.0.7** (published 2018-08-09) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @carto/zera
pnpm add @carto/zera
yarn add @carto/zera
bun add @carto/zera
```

## 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.0.7 |
| Published | 2018-08-09 |
| First published | 2018-04-24 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 48.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | albertoag, algunenano, alonsogarciapablo, cartodb, csubira, dgaubert, dmanzanares, elenatorro, enekid, iagolast, ivanmalagon, jesus-arroyo, juanignaciosl, oleurud, piensenpixel, rochoa, romanjimenez, rubenmoya, sconde |

## Links

- npm: https://www.npmjs.com/package/@carto/zera
- npm.io page: https://npm.io/package/@carto/zera

## Recent versions

- 1.0.7 (latest) — 2018-08-09
- 1.0.6-staging.2 — 2018-08-08
- 1.0.6 — 2018-05-04
- 1.0.4 — 2018-04-25
- 1.0.0 — 2018-04-24

## README

# zera

Grid json client for `Leaflet` and `Google Maps`.


## Installing zera

    yarn add @carto/zera

## Testing

zera uses [jest](https://facebook.github.io/jest/) for executing the unit tests located under the `__test__ ` folder and
[karma with headless chrome](https://developers.google.com/web/updates/2017/06/headless-karma-mocha-chai) for running the tests located under the `test` folder.

By default you need to be able to run [headless chrome](https://developers.google.com/web/updates/2017/04/headless-chrome) on your machine. But you can also edit the `karma.config.js` file and change the browser.

### Running the thests

    yarn test


## Building
zera uses [webpack](https://webpack.js.org/concepts/) to generate an umd bundle located under the `dist` folder.

    yarn build



## api


#### `new zera.Interactive([map], [gridUrl])`

Creates a new `zera` object.

`map` is a reference to the native google|leaflet map and `gridUrl` is a string pointing to the grid.json url server.


```javascript
const map = L.map('map').setView([42, -0.08], 5);
const gridUrl = 'https://carto.com/map_id/1/{z}/{x}/{y}.grid.json';
const interactivity = new zera.Interactive(map, '');
```

#### `zera.on(event, callback)`

Attaches event listeners to map events.
Only a single listener can be attached for every event type.
There are only three possible events:

- **on:** Fired when the user clicks or moves the mouse over a feature. You can distinguish between them using `event.type` property.
- **off:** Fired when the user clicks or moves the mouse off from a feature.
- **error** Fired when there was an error getting the `grid.json` for a interaction.
    - This includes `CARTO-429` limit error.

```javascript
zera.on('on', event => {
    popup.setLatLng(event.latlng);
    popup.setContent(`<h5>${event.data.name}</h5> <h6> ${event.type} </h6>`);
    popup.openOn(map);
})
```

#### `zera.off(event)`

Removes an event listener.

```javascript
zera.off('on');
```


#### `zera.remove()`

Removes all the interactivity and callbacks.

```javascript
zera.remove();
```

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