Examples Overview
Use this section as a practical map of the SDK. The examples are grouped by behavior so you can jump directly to the API surface you need instead of reading the whole documentation in order.
What each example documents
| Example | Focus | Best for |
|---|---|---|
| Framework Installation | Angular, React, Lit, vanilla JS setup | Choosing an integration path |
| Create a Map | initializeSDK, createMap, callbacks | First integration |
| Map Controls and Bounds | camera, bounds, language, tile cache | Viewport and map state |
| Basic Markers | marker lifecycle | CRUD for markers |
| Marker Icons | icon, iconProperties, anchor | Visual marker variants |
| HTML Markers | element, custom DOM, click handling | Rich marker UI |
| Circles / Radius Overlays | circle lifecycle, metric radius | Geofence visualization |
| Place Interaction | search, clicks, polygon styling | Place discovery flows |
| Places, Markers, and Routes | MVXPlace with marker and route flows | End-to-end map interactions |
| Routes | addRoute, multiple routes, route progress | Static routing |
| Route Animation | animated routes and step controls | Navigation UI |
| Floor Management | parent place and floor transitions | Indoor maps |
| User Tracking | position, heading, user marker | Live user location |
| Geolocation Override | custom Geolocation for testing/simulation | Automated testing |
| Remote Configuration | getConfiguration, CSS customization | Directory and totem setups |
| Data Loading | places, subplaces, cache, configuration | SDK data orchestration |
| Service Worker | offline tile caching via service worker | Offline-capable maps |
| Preconnect | early connection warm-up | Faster first map render |
| Complete Example | full SDK implementation end-to-end | Copy-paste starting point |
Capability matrix
| Capability | Outdoor | Indoor | Mixed |
|---|---|---|---|
| Create and configure a map | Create a Map | Create a Map | Complete Example |
| Bounds, camera, zoom, language | Map Controls and Bounds | Map Controls and Bounds | Map Controls and Bounds |
| Marker CRUD | Basic Markers | Basic Markers | Marker Icons |
| Custom marker DOM | HTML Markers | HTML Markers | Places, Markers, and Routes |
| Polygon selection and borders | Place Interaction | Place Interaction | Places, Markers, and Routes |
| Route drawing | Routes | Routes | Places, Markers, and Routes |
| Route animation | Limited | Route Animation | Route Animation |
| Floor switching | Not applicable | Floor Management | Floor Management |
| User tracking | User Tracking | User Tracking | Geolocation Override |
| Remote configuration | Remote Configuration | Remote Configuration | Data Loading |
Notes on visual validation
The public examples in this section intentionally use placeholders instead of real credentials. The internal visual harness that captures screenshots and smoke-tests real indoor/outdoor clients lives outside the published docs content and is designed to receive API keys through environment variables.
Last updated on