Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

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 package.json file:

1
2
3
4
5

"dependencies": {
...
   "kinetica-kickbox-mapbox-gl": "github:kineticadb/kinetica-kickbox-mapbox-gl",
...
}

Then run:

1

npm install

Once it's in your node_modules folder, you can either reference the node_modules/kinetica-kickbox-mapbox-gl/dist/kickbox.min.js directly from your index.html, or use something like this in your JavaScript framework:

1

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