@aegirmaps/aegir-js-sdk v2.0.0-beta.16

JavaScript SDK for Indoor Maps

The JavaScript SDK provides advanced rendering and navigation features, as well as deep linking ability, for indoor maps.

Concepts

Venue Map Data (VMD) provides functions for programatic access to venue metadata about the venue, including buildings, floors, and places within. Support for rendering the map for interactive applications is provided with the combination of VMD information served from VMD endpoints (or locally for offline support), and optionally assets served by mapping providers (Google, Apple, Open Street Maps, etc) for interactions that involve context of the geo-coded location of the venue.

Venue Object Model

• A Venue is a collection of buildings and outdoor floors that represent the space between buildings (parking lots, walyways, outdoor fixtures).
• A Building is a collection of floors.
• A Floor is a collection of units/places.
• A Unit/Place is visually represented as a point or polygon that describes the shape, with a unique placeId for identification. These also have categories and other meta-data that can be used to provide visual annotations, or deep link buisiness actions.

Styling and Visualization

The SDK provides default styles and icons for rendering the venue, which can be customized by the developer. Tiles serve as the data source for rendering and visualization, with various options for performance and detail. Our reference apps refernce a public style endpoint that is sufficent for development and getting started. Application teams should account for their own style assets as one of the VMD endpoints to consider during architecting your solution.

Getting Started

Obtain your NPM Key from your account rep.

Include the private SDK in your project with npm or yarn.

The best way to do this is to included it in your .npmrc file and pass it in through the environment through a variable such as NPM_NPMJS_TOKEN. You can optionally also just put it in the .npmrc file if you are not going to add that file into your repository for your application.

//registry.npmjs.org/:_authToken=${NPM_NPMJS_TOKEN}
#always-auth=true

Then add it into your package.json using yarn add or npm install or directly into your package.json with a line similar to this.

"@aegirmaps/aegir-js-sdk": "^2.0.0"

Use the provided methods to render and navigate the venue

For more information, refer to the Documentation and Examples on developer.aegirmaps.com, and checkout our basic react reference app as a good place to get started.