> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Kinetica Kickbox.js Mapbox GL

## Library Overview

*Kinetica Kickbox.js* is a client-side code-accelerator library aimed at getting
you up and running with *Kinetica* and *Mapbox GL* as quickly as possible.

## Purpose

While *Mapbox* is fully interoperable with *Kinetica* natively, the workflow for
displaying *Kinetica's* WMS layers can be tricky to implement without knowing
the best practices regarding their integration. Furthermore, there are common
patterns that begin to emerge and this library aims to reduce the amount of code
required to simply connect *Kinetica's* WMS output to *Mapbox*.

## Features

This library provides common helper functions that make it easier to implement:

* WMS Layers

  * Raster Layers
  * Heatmap Layers
  * CB Raster Layers
  * Labels Layers
  * Contour Layers

* Geohashed Point Cluster Layers

* Feature Identification workflows

## Installation

Add this line to your <Badge color="gray">package.json</Badge> file:

```javascript theme={null}
"dependencies": {
...
   "kinetica-kickbox-mapbox-gl": "github:kineticadb/kinetica-kickbox-mapbox-gl",
...
}
```

Then run:

```bash theme={null}
npm install
```

Once it's in your <Badge color="gray">node\_modules</Badge> folder, you can either reference the
<Badge color="gray">node\_modules/kinetica-kickbox-mapbox-gl/dist/kickbox.min.js</Badge> directly
from your <Badge color="gray">index.html</Badge>, or use something like this in your *JavaScript*
framework:

```javascript theme={null}
const kickbox = require('kinetica-kickbox-mapbox-gl');
```

You can also grab a copy of *Kinetica Kickbox.js* from our GitHub page here:
[https://github.com/kineticadb/kinetica-kickbox-mapbox-gl](https://github.com/kineticadb/kinetica-kickbox-mapbox-gl)

## Getting Started

* [API Documentation](/content/connectors/kickbox_api)
* [WMS Layers](/content/connectors/kickbox_wms)
* [Point Clustering](/content/connectors/kickbox_clustering)