https://github.com/terrestris/ol-util

A set of helper classes for working with OpenLayers
https://github.com/terrestris/ol-util

hacktoberfest openlayers proj4js turfjs utility

Last synced: 4 months ago
JSON representation

A set of helper classes for working with OpenLayers

• Host: GitHub
• URL: https://github.com/terrestris/ol-util
• Owner: terrestris
• License: bsd-2-clause
• Created: 2018-07-12T10:02:36.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2025-03-25T10:06:07.000Z (over 1 year ago)
• Last Synced: 2025-03-28T05:12:38.474Z (over 1 year ago)
• Topics: hacktoberfest, openlayers, proj4js, turfjs, utility
• Language: TypeScript
• Homepage: https://terrestris.github.io/ol-util
• Size: 116 MB
• Stars: 47
• Watchers: 13
• Forks: 20
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ol-util

[![npm version](https://img.shields.io/npm/v/@terrestris/ol-util.svg?style=flat-square)](https://www.npmjs.com/package/@terrestris/ol-util)

[![GitHub license](https://img.shields.io/github/license/terrestris/ol-util?style=flat-square)](https://github.com/terrestris/ol-util/blob/main/LICENSE)

[![Coverage Status](https://img.shields.io/coverallsCoverage/github/terrestris/ol-util?style=flat-square)](https://coveralls.io/github/terrestris/ol-util?branch=main)

![GitHub action build](https://img.shields.io/github/actions/workflow/status/terrestris/ol-util/on-push-main.yml?branch=main&style=flat-square)

A set of helper classes for working with OpenLayers

## Installation

```javascript static

npm i @terrestris/ol-util

```

Be aware that ol-util uses a ESM build, so make sure your downstream application's bundler includes it when transpiling.

## API Documentation

* Latest: [https://terrestris.github.io/ol-util/latest/index.html](https://terrestris.github.io/ol-util/latest/index.html)

* Docs for other versions are available via the following format:

  * v3.0.0 [https://terrestris.github.io/ol-util/3.0.0/index.html](https://terrestris.github.io/ol-util/3.0.0/index.html)

## Development

`npm run watch:buildto` can be used to inject an updated version of `ol-util` into another project. The script will also watch for further changes. Example usage for [react-geo](https://github.com/terrestris/react-geo):

```sh

npm run watch:buildto ../react-geo/node_modules/@terrestris/ol-util

```

## Release

A new version is released automatically for new commits to the main branch using [semantic release](https://github.com/semantic-release/semantic-release).

## Software Bill of Materials

You find the SBOM (Software Bill of Materials) in `sbom.json` at root level of the project.