https://github.com/mapbox/tokml

Convert GeoJSON to KML.
https://github.com/mapbox/tokml

Last synced: 3 days ago
JSON representation

Convert GeoJSON to KML.

• Host: GitHub
• URL: https://github.com/mapbox/tokml
• Owner: mapbox
• License: bsd-2-clause
• Created: 2013-10-08T22:56:47.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2018-05-06T02:00:31.000Z (over 6 years ago)
• Last Synced: 2024-09-25T06:59:03.407Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://mapbox.github.io/tokml/
• Size: 94.7 KB
• Stars: 185
• Watchers: 113
• Forks: 90
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mapbox/tokml.png)](https://travis-ci.org/mapbox/tokml) [![Coverage Status](https://coveralls.io/repos/mapbox/tokml/badge.png)](https://coveralls.io/r/mapbox/tokml)

# tokml

Convert [GeoJSON](http://geojson.org/) to [KML](https://developers.google.com/kml/documentation/).

## Usage

with node/browserify

    npm install --save tokml

otherwise:

    wget https://raw.github.com/mapbox/tokml/master/tokml.js

as a binary:

    npm install -g tokml

    tokml file.geojson > file.kml

    tokml < file.geojson > file.kml

## Example

```js

// kml is a string of KML data, geojsonObject is a JavaScript object of

// GeoJSON data

var kml = tokml(geojsonObject);

// grab name and description properties from each object and write them in

// KML

var kmlNameDescription = tokml(geojsonObject, {

    name: 'name',

    description: 'description'

});

// name and describe the KML document as a whole

var kmlDocumentName = tokml(geojsonObject, {

    documentName: 'My List Of Markers',

    documentDescription: "One of the many places you are not I am"

});

```

## API

### `tokml(geojsonObject, [options])`

Given [GeoJSON](http://geojson.org/) data as an object, return KML data as a

string of XML.

`options` is an optional object that takes the following options:

**The property to name/description mapping:** while GeoJSON supports freeform

`properties` on each feature, KML has an expectation of `name` and `description`

properties that are often styled and displayed automatically. These options let

you define a mapping from the GeoJSON style to KML's.

* `name`: the name of the property in each GeoJSON Feature that contains

  the feature's name

* `description`: the name of the property in each GeoJSON Feature that contains

  the feature's description

**Timestamp:** KML can associate features with a moment in time via the `TimeStamp` tag.  GeoJSON doesn't

have a comparable field, but a custom property can be mapped

* `timestamp`: the name of the property in each GeoJSON Feature that contains 

  a timestamp in XML Schema Time (yyyy-mm-ddThh:mm:sszzzzzz)  

**Document name and description**: KML supports `name` and `description` properties

for the full document.

* `documentName`: the name of the full document

* `documentDescription`: the description of the full document

**[simplestyle-spec](https://github.com/mapbox/simplestyle-spec)** support:

* `simplestyle`: set to `true` to convert simplestyle-spec styles into KML styles

## Development

Requires [node.js](http://nodejs.org/) and [browserify](https://github.com/substack/node-browserify):

To build `tokml.js`:

    make

To run tests:

    npm install

    npm test