CartoDB javascript library
JavaScript CSS Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add github files Apr 20, 2018
config/jsdoc Changing repo references Apr 17, 2018
docs Fix lib reference docs Aug 9, 2018
examples fix popups/featureClick positions when scrolled Jul 16, 2018
grunt Use SpecHelper instead of Browserify for __ENV__ var Jul 5, 2018
scripts Fix gh-pages examples deploy Jul 11, 2018
src Trigger vis-view click event in vis-model to listen to it in Builder Aug 8, 2018
test Increase timout for api/v4/source/dataset specs Aug 9, 2018
themes Fix gradient legends margin Jul 5, 2018
vendor Fix LZMA for both public and internal bundles Dec 13, 2017
webpack Merge branch 'master' into 2139-add-metric Jul 5, 2018
.editorconfig Add editorconfig Sep 5, 2017
.eslintignore Remove BOWER stuff Nov 14, 2017
.eslintrc.json Send client metric only in production Jul 4, 2018
.gitignore Add two files to gitignore Jul 12, 2018
.gitmodules Run tests from the command line using PhantomJS Apr 24, 2013
.hound.yml Remove Gemfile (compass) Jul 9, 2018
.npmrc Add npm version configuration Oct 4, 2017
.scss-lint.yml Remove Gemfile (compass) Jul 9, 2018
.travis.yml Add publish:npm script Dec 11, 2017
CHANGELOG.md Update CHANGELOG and DEVLOG Jul 13, 2018
DEVLOG.md Update CHANGELOG and DEVLOG Jul 13, 2018
Gruntfile.js Carto.js -> CARTO.js Dec 14, 2017
LICENSE.txt Remove .md files and simplify README.md Nov 21, 2017
README.md Change 4.0 to 4 in README Jul 13, 2018
gulpfile.js Fix huge lint Sep 11, 2017
index.html Moved dist to dist/internal Nov 14, 2017
package.json Bump version to 4.1.3 Aug 9, 2018
secrets.example.json Update publish CDN task. Add release:cdn command Dec 12, 2017

README.md

CARTO.js 4

CARTO.js is a JavaScript library to create custom location intelligence applications that leverage the power of CARTO. It is the library that powers Builder and it is part of the Engine ecosystem.

Getting Started

The best way to get started is to navigate through the CARTO.js documentation site:

  • Guide will give you a good overview of the library.
  • API Reference will help you use a particular class or method.
  • Examples will demo some specific features.
  • Support might answer some of your questions.

Versioning

We use SemVer for versioning.

Please refer to CHANGELOG.md for a list of notables changes for each version of the library.

You can also see the tags on this repository.

Submitting Contributions

You will need to sign a Contributor License Agreement (CLA) before making a submission. Learn more here.

License

This project is licensed under the BSD 3-clause "New" or "Revised" License - see the LICENSE.txt file for details.

Documentation

API Reference

Run npm run docs to build the API reference documentation from jsdoc annotations.

Once the task is done, you can visit docs/public/index.html to check the reference

General documentation

You can read the general documentation that is published at https://carto.com/developers/cartojs/ also in this repo. They are written in Markdown.

Warning: internal links in these documents don't work. They are replaced when the documentation is published in https://carto.com/

Guides

The folder docs/guides contains general information about the CARTO.js library.

  • Quickstart: get started quickly following this tutorial.
  • Upgrade considerations: if you have experience with previous versions of CARTO.js, this is the place to learn the differences between the former library and the newest one.
  • Glossary: terms that appear throughout the documentation.

Examples

In the folder examples/public you can find several folders with example for every feature of CARTO.js.

Reference topics

The document docs/reference/topics.md contains general considerations when working with CARTO.js. It's advisable to read them before diving in the API reference.

Support

The folder docs/support contains several document with support documentation: support options, FAQs, error messages...

Development

Run the tests

npm test

Build the library

npm run build

To watch the files

npm run build:watch

Generate the docs

npm run docs

Release version

npm run bump

To publish a release to the CDN and npm

npm run release

Looking for the previous version?

Previous version cartodb.js v3 it's available here