The Giraffe Javascript SDK allows developers to write custom web apps that extend the functionality of Giraffe. Apps can read and write data from the Giraffe map such as geometries, layers and UI state (eg a user’s current selection).

An app is rendered in an Iframe on the right of the screen. It can interact with other areas of Giraffe through the SDK functions.

Screen Shot 2023-10-04 at 2.57.11 pm.png

<aside> 1️⃣ Iframe SDK Setup


<aside> ✂️ Code Snippets


<aside> <img src="" alt="" width="40px" /> Git repo with full example apps


<aside> 🤓 SDK API Documentation for all available data and functions.


Background on Apps

Apps can make designing and developing cities more fun, fast and collaborative. Giraffe comes with a number of apps built in, but we've only scratched the surface of what's possible.

To empower technical users and reduce the cost of deploying business grade custom software, we've released a new javascript SDK$^1$ . This allows (web) developers to connect their own web app to the Giraffe platform. They can leverage Giraffe authentication, hosting, geometries, layers and more to get from prototype to production faster.

The Giraffe JS SDK is modelled around GeoJSON, because we believe simple formats like this drive automation and interesting analysis.

There are two ways to call the same set of SDK functions - the Iframe Post-message SDK and the Console JS SDK. Both of these will rapidly expand Giraffe’s analytics capacity.

Iframe Post-message SDK

Console JS SDK - examples