Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mchalgarra/kml-to-json
A library that contains methods to convert KML to JSON and JSON to KML.
https://github.com/mchalgarra/kml-to-json
javascript json kml library parser typescript web
Last synced: about 1 month ago
JSON representation
A library that contains methods to convert KML to JSON and JSON to KML.
- Host: GitHub
- URL: https://github.com/mchalgarra/kml-to-json
- Owner: mchalgarra
- License: mit
- Created: 2021-10-26T12:22:31.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2022-11-03T03:07:10.000Z (about 2 years ago)
- Last Synced: 2024-10-05T12:17:02.795Z (about 1 month ago)
- Topics: javascript, json, kml, library, parser, typescript, web
- Language: TypeScript
- Homepage:
- Size: 187 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KML to JSON
## About
KML to JSON is a library made with Typescript that contains tools for KML files conversion.
## Installing
First, be sure to have [Node.js](https://nodejs.org/en/) installed.
Then, install it by running:
```bash
$ npm install --save kml-to-json
```
## Usage
The library has 4 functions that may be used. They are:
- ### kmlToJson
It converts a KML file to a JSON object, keeping all tags names, attributes, texts and children.
Receives a file of the type `application/vnd.google-earth.kml+xml` or with the extension `kml`.
> It throws an error when the file type is incorrect.
Returns an object containing all KML data with [this structure](#json-structure).
```ts
kmlToJson(file: File): Object
```
- ### kmlToJsonString
It converts a KML file to a JSON string, representing all tags names, attributes, texts and children.
Receives a file of the type `application/vnd.google-earth.kml+xml` or with the extension `kml`.
> It throws an error when the file type is incorrect.
Returns a string representing the KML data with [this structure](#json-structure).
```ts
kmlToJsonString(file: File): string
```
- ### jsonToKml
It converts a JSON object or string to a KML file.
Receives an object or string with [this structure](#json-structure).
> It throws an error when the given parameter is not from type object or string.
Returns a blob that represents the KML file. Its type is `application/vnd.google-earth.kml+xml`.
```ts
jsonToKml(json: Object | string): Blob
```
- ### jsonToKmlString
It converts a JSON object or string to a structured KML string.
Receives an object or string with [this structure](#json-structure).
> It throws an error when the given parameter is not from type object or string.
Returns a string that represents the KML string structure.
```ts
jsonToKmlString(json: Object | string): string
```
## JSON Structure
```ts
{
"test-tag": {
"attributes": {
"attr1": null,
"attr2": null,
"class": "class-1",
"id": "test-tag"
},
"children": {
"child1": {
"attributes": {},
"order": 0,
"children": {
"child3": {
"attributes": {
"attr3": null
},
"children": {
"text0": {
"data": "Some text...",
"order": 0
}
},
"order": 0,
}
}
},
"child2": {
"attributes": {},
"order": 1,
"children": {}
}
},
"order": 0,
}
}
```
## License
The KmlToJson project is licensed under the [MIT license](https://opensource.org/licenses/MIT).