Appearance
Giới thiệu
VGM Map SDK (@vgm/map-sdk-js) là thư viện JavaScript để bạn nhúng bản đồ indoor/outdoor vào website hoặc ứng dụng web của mình.
Bạn cài gói npm hoặc tải script từ CDN do VGMMap cung cấp — không cần clone hay build mã nguồn nền tảng bản đồ. Phần nặng (MapLibre, dữ liệu site, UI tìm kiếm / chỉ đường…) chạy trong iframe do VGM host tại URL apiBase.
Hai thành phần bạn cần biết
| Thành phần | Vai trò của bạn |
|---|---|
Thư viện VGMMap (trang của bạn) | Cài qua npm hoặc <script src="...">. Tạo iframe, gửi lệnh setView, addLayer, … và sdk.on(...) để nhận sự kiện. |
| App bản đồ (iframe) | Do VGMMap vận hành tại apiBase (ví dụ https://maps.vgm.ai/vgm-sdk). Bạn chỉ cấu hình apiBase, siteId, token theo hợp đồng. |
Trang host không cài MapLibre để vẽ nền bản đồ; mọi tương tác trực quan diễn ra trong iframe. SDK đóng vai cầu nối qua postMessage.
Luồng làm việc điển hình
- Cài SDK → có
VGMMap(import hoặc global). new VGMMap({ container, siteId, token, apiBase })→sdk.on("APP_READY", …)→sdk.init().- Khi nhận
APP_READY, SDK gửi xuống iframe mọi lệnh đã gọi trước đó (hàng đợi). - Gọi
setView,addLayer,setSite, … và xử lýFLOOR_CHANGED,poiClicked, …
Ai nên đọc tài liệu này
- Lập trình viên tích hợp bản đồ vào sản phẩm (HTML, React, Vue, …).
- Biết cơ bản DOM, async, và nên hiểu sơ
postMessagekhi triển khai production an toàn.
