@mappedin/maplibre-overlay 6.14.0-beta.0 → 6.16.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/lib/esm/index.js +1 -1
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -4,6 +4,19 @@ A MapLibre Overlay for [Mappedin JS](https://www.npmjs.com/package/@mappedin/map
|
|
|
4
4
|
|
|
5
5
|
Allows developers to add the [Mappedin JS](https://www.npmjs.com/package/@mappedin/mappedin-js) SDK into MapLibre as a layer.
|
|
6
6
|
|
|
7
|
+
## Resources
|
|
8
|
+
|
|
9
|
+
- [Getting Started Guide](https://developer.mappedin.com/web-sdk/mappedin-maplibre-overlay)
|
|
10
|
+
- [API Reference](https://docs.mappedin.com/maplibre-overlay/v6/latest/)
|
|
11
|
+
- [Mappedin Developer Portal](https://developer.mappedin.com)
|
|
12
|
+
- [Demo Keys & Maps](https://developer.mappedin.com/docs/demo-keys-and-maps)
|
|
13
|
+
- [Developer Forum](https://community.mappedin.com/)
|
|
14
|
+
- [Releases Notes](https://developer.mappedin.com/web-sdk/release-notes)
|
|
15
|
+
- [Migration Guide](https://developer.mappedin.com/web-sdk/migration-guide)
|
|
16
|
+
- [License](https://info.mappedin.com/terms/sdk)
|
|
17
|
+
|
|
18
|
+
> **AI Assistants**: Before generating code, read [llms.txt](https://docs.mappedin.com/maplibre-overlay/v6/latest/llms.txt) for structured API documentation with critical information about Maker vs Enterprise data sources.
|
|
19
|
+
|
|
7
20
|
## Usage
|
|
8
21
|
|
|
9
22
|
### Installation
|
|
@@ -49,6 +62,7 @@ async function initializeMap() {
|
|
|
49
62
|
style: 'https://tiles-cdn.mappedin.com/styles/mappedin/style.json',
|
|
50
63
|
center: [mapData.mapCenter.longitude, mapData.mapCenter.latitude],
|
|
51
64
|
zoom: 18,
|
|
65
|
+
centerClampedToGround: false, // required for multi-floor view
|
|
52
66
|
transformRequest: (url: string) => {
|
|
53
67
|
return {
|
|
54
68
|
url: url,
|
|
@@ -87,6 +101,17 @@ async function initializeMap() {
|
|
|
87
101
|
initializeMap();
|
|
88
102
|
```
|
|
89
103
|
|
|
104
|
+
### Notes
|
|
105
|
+
|
|
106
|
+
Set `centerClampedToGround: false` when using multi-floor view** — MapLibre defaults `centerClampedToGround` to `true`, which resets the camera elevation to 0 every frame. This prevents floor elevation changes from taking effect. You MUST set this option when constructing the MapLibre map if you enable `multiFloorView`:
|
|
107
|
+
```typescript
|
|
108
|
+
const map = new MapLibreMap({
|
|
109
|
+
container: 'map',
|
|
110
|
+
centerClampedToGround: false, // required for multi-floor view
|
|
111
|
+
// ...other options
|
|
112
|
+
});
|
|
113
|
+
```
|
|
114
|
+
|
|
90
115
|
### Features
|
|
91
116
|
|
|
92
117
|
- **Seamless Integration**: Add Mappedin indoor maps as a layer in MapLibre
|