Unit Map

Unit Map™ Developer Hub

Welcome to the Unit Map developer hub. You'll find comprehensive guides and documentation to help you start working with the platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Querying

A main design goal of the SDK is to provide a succinct, efficient API for manipulating and querying a Unit Map™. This is achieved through selection objects which provide a chaining API and maintain a collection of the objects they represent. Each set can further be manipulated and filtered using methods such as find, where, has, etc; similar to jQuery and other jQuery-like API's.

For instance, the following code sample will set the fill color to #f0f for Unit objects with ID's of 1, 2, 3, 4, or 5.

map.units().find([1, 2, 3, 4, 5]).color('#f0f');

All queryable values should be strings, however the values are cast internally, so it's safe to pass integer representations.

Updated 2 years ago


What's Next

You can learn more about selection objects in the following API Reference section.

LevelSelection
UnitSelection

Querying


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.