Install via NPM
- Login to your account on globekit.co
- Copy your APIKEY
- run
npm install globekit-public
in your project directory - Enter API KEY and email when prompted. This will create a
.globekit
file in the project root
For more installation directions, refer to 00-00-installation.
Examples
- Data points - 10,000 datapoints
- Headquarters - Connections to the home base
- Points of Interest - Use a DOM element as the marker
- Tour - Animate the camera between locations
- Lookup - Highlight regions on click
Additional examples coming soon.
Run examples
- Change
{YOUR_API_KEY}
to your api key in the source files - Start a server in package root with something like
python3 -m http.server
- Open a browser and navigate to
/examples
, and select an example
Things to note
- The current development runtime only works on
localhost
not127.0.0.1
, this is intentional. Please contact us if you are having problems with your development site. - The size of the canvas is determined by CSS.
- To get the best results when using a texture, ensure the size of the texture is a power of 2, e.g. 256, 1024, 2048, etc. We are working on a system to automatically resize these images, but there is a performance cost, so it is currently best to avoid this all together.
Files in SDK download
globekit.ems.js
- GlobeKit module, used in nearly all applications so most likely you need to copy this file.
globekit.cjs.js
- GlobeKit common js
globekit.umd.js
- GlobeKit UMD.
gkweb_bg.wasm
- needs to be served as a static resource
./assets
- has the files for pointglobe and lowpoly globes.
./examples
- get a sense of how to use GlobeKit in your projects.