# tangram-reference

> Reference for Tangram Styling Options

Latest version **2.1.2** (published 2018-02-02) · 0 weekly downloads

## Install

```sh
npm install tangram-reference
pnpm add tangram-reference
yarn add tangram-reference
bun add tangram-reference
```

## 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 | 2.1.2 |
| Published | 2018-02-02 |
| First published | 2016-12-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Carto |
| Maintainers | dmanzanares, alonsogarciapablo, iagolast, cartodb |

## Links

- npm: https://www.npmjs.com/package/tangram-reference
- Repository: https://github.com/cartodb/tangram-reference
- Homepage: https://github.com/cartodb/tangram-reference#readme
- Issues: https://github.com/cartodb/tangram-reference/issues
- npm.io page: https://npm.io/package/tangram-reference

## Recent versions

- 2.1.2 (latest) — 2018-02-02
- 2.1.0 — 2017-09-08
- 2.0.1 — 2017-09-05
- 2.0.0 — 2017-09-04
- 1.0.20 — 2017-09-04
- 1.0.19 — 2017-08-09
- 1.0.18 — 2017-06-13
- 1.0.17 — 2017-02-01
- 1.0.16 — 2017-01-26
- 1.0.15 — 2017-01-19
- 1.0.14 — 2017-01-05
- 1.0.12 — 2017-01-04
- 1.0.11 — 2017-01-04
- 1.0.10 — 2017-01-03
- 1.0.9 — 2016-12-21
- … 9 more at https://npm.io/package/tangram-reference/versions

## README

# [DEPRECATED] Tangram-reference [![Build Status](https://travis-ci.org/CartoDB/tangram-reference.svg?branch=unsupported-properties)](https://travis-ci.org/CartoDB/tangram-reference) ![No Maintenance Intended](https://img.shields.io/badge/No%20Maintenance%20Intended-%E2%9C%95-red.svg)

This is no longer supported.

Tangram-reference is a JSON specification of the CartoCSS vendor style options that [Torque](https://github.com/CartoDB/torque) provides. Inspired by [mapnik-reference](https://github.com/mapnik/mapnik-reference), *it is useful for building parsers, tests, compilers, and syntax highlighting/checking for languages.*

## Meaning

The structure of the file is as such:

* `version`: the version of Torque targeted. Same as the containing directory.
* `style`: properties of the `Style` XML element
* `layer`: properties of the `Layer` XML element
* `symbolizers/*`: properties that apply to **all** symbolizers
* `colors`: named colors supported by Torque

## Using

This is a valid [npm](http://npmjs.org/) module and therefore can easily be used with
[node.js](http://nodejs.org/).

    npm install tangram-reference

The file can then be parsed with any of the many [json parsers](http://www.json.org/).

## Testing

```
npm test
```

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