mahal_map 1.6.16 → 1.6.17
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 +14 -6
- package/dist/index.d.mts +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +1 -1
- package/dist/mahal_map.sdk.js +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -12,16 +12,24 @@ npm install mahal_map maplibre-gl
|
|
|
12
12
|
|
|
13
13
|
`maplibre-gl` является peer dependency. Его нужно установить в приложении или подключить отдельным browser script перед SDK.
|
|
14
14
|
|
|
15
|
-
Для нового 3D-движка (`engine: "3d"`) дополнительно нужен `@
|
|
15
|
+
Для нового 3D-движка (`engine: "3d"`) дополнительно нужен `@grammaps/maps3d-web`:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm i @grammaps/maps3d-web maplibre-gl
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
`three` идёт зависимостью SDK, `maplibre-gl` — peer (экземпляр карты создаёте вы через `mahal_map`).
|
|
22
|
+
|
|
23
|
+
Оффлайн-вариант: в стартере со страницы платформы лежит папка `libs/maps3d-web` со собранным `dist/` — ставится как локальная зависимость:
|
|
16
24
|
|
|
17
25
|
```sh
|
|
18
26
|
npm i ./libs/maps3d-web maplibre-gl
|
|
19
27
|
```
|
|
20
28
|
|
|
21
|
-
`package.json` запишет ссылку на локальную папку:
|
|
29
|
+
`package.json` в этом случае запишет ссылку на локальную папку:
|
|
22
30
|
|
|
23
31
|
```json
|
|
24
|
-
"@
|
|
32
|
+
"@grammaps/maps3d-web": "file:./libs/maps3d-web"
|
|
25
33
|
```
|
|
26
34
|
|
|
27
35
|
Без сборщика возьмите `lib/maps3d.global.js` из скачанного стартера (IIFE-глобал `Maps3D`, three бандлится внутрь) и подключите скриптом после `maplibre-gl`:
|
|
@@ -157,7 +165,7 @@ interface IMahalMapOptions {
|
|
|
157
165
|
```ts
|
|
158
166
|
import maplibregl from "maplibre-gl";
|
|
159
167
|
import "maplibre-gl/dist/maplibre-gl.css";
|
|
160
|
-
import { Maps3D } from "@
|
|
168
|
+
import { Maps3D } from "@grammaps/maps3d-web";
|
|
161
169
|
import { MahalMap, keyUtils } from "mahal_map";
|
|
162
170
|
|
|
163
171
|
keyUtils.saveKey("YOUR_MAP_API_KEY");
|
|
@@ -177,7 +185,7 @@ const map = MahalMap.create(
|
|
|
177
185
|
);
|
|
178
186
|
```
|
|
179
187
|
|
|
180
|
-
`Maps3D` (третий аргумент `create()`) — опционален: если не передан, SDK попробует взять его из `window.Maps3D`. `@
|
|
188
|
+
`Maps3D` (третий аргумент `create()`) — опционален: если не передан, SDK попробует взять его из `window.Maps3D`. `@grammaps/maps3d-web` — необязательный peer dependency, ставится только если используется `engine: "3d"`.
|
|
181
189
|
|
|
182
190
|
Получить слой Maps3D после создания карты:
|
|
183
191
|
|
|
@@ -187,7 +195,7 @@ const layer = map.getMaps3DLayer();
|
|
|
187
195
|
MahalMap.getMaps3DLayer(map);
|
|
188
196
|
```
|
|
189
197
|
|
|
190
|
-
`getMaps3DLayer()` возвращает реальный инстанс `Maps3D` (не обёртку) — типы `mahal_map` описывают всю его публичную поверхность, так что подключающему сервису не нужно ставить или типизировать `@
|
|
198
|
+
`getMaps3DLayer()` возвращает реальный инстанс `Maps3D` (не обёртку) — типы `mahal_map` описывают всю его публичную поверхность, так что подключающему сервису не нужно ставить или типизировать `@grammaps/maps3d-web` отдельно.
|
|
191
199
|
|
|
192
200
|
### Опции `maps3d` (расширенные)
|
|
193
201
|
|
package/dist/index.d.mts
CHANGED
|
@@ -248,6 +248,7 @@ declare class MahalMap {
|
|
|
248
248
|
static getMap(instance: MahalMap): Map;
|
|
249
249
|
static setStyle(instance: MahalMap, theme: Theme): void;
|
|
250
250
|
static getMaps3DLayer(instance: MahalMap): IMaps3DLayer | undefined;
|
|
251
|
+
static toggle3DBuildings(instance: MahalMap, enabled: boolean): void;
|
|
251
252
|
static setLanguage(instance: MahalMap, lang: MapLanguage): void;
|
|
252
253
|
static setCenter(instance: MahalMap, center: [number, number]): void;
|
|
253
254
|
static setZoom(instance: MahalMap, zoom: number): void;
|
|
@@ -259,6 +260,8 @@ declare class MahalMap {
|
|
|
259
260
|
setStyle(theme: Theme): void;
|
|
260
261
|
setLanguage(lang: MapLanguage): void;
|
|
261
262
|
getMaps3DLayer(): IMaps3DLayer | undefined;
|
|
263
|
+
/** Вкл/выкл детальные 3D-здания (Maps3D). Работает только для engine: "3d". */
|
|
264
|
+
toggle3DBuildings(enabled: boolean): void;
|
|
262
265
|
setCenter(center: [number, number]): void;
|
|
263
266
|
setZoom(zoom: number): void;
|
|
264
267
|
destroy(): void;
|
package/dist/index.d.ts
CHANGED
|
@@ -248,6 +248,7 @@ declare class MahalMap {
|
|
|
248
248
|
static getMap(instance: MahalMap): Map;
|
|
249
249
|
static setStyle(instance: MahalMap, theme: Theme): void;
|
|
250
250
|
static getMaps3DLayer(instance: MahalMap): IMaps3DLayer | undefined;
|
|
251
|
+
static toggle3DBuildings(instance: MahalMap, enabled: boolean): void;
|
|
251
252
|
static setLanguage(instance: MahalMap, lang: MapLanguage): void;
|
|
252
253
|
static setCenter(instance: MahalMap, center: [number, number]): void;
|
|
253
254
|
static setZoom(instance: MahalMap, zoom: number): void;
|
|
@@ -259,6 +260,8 @@ declare class MahalMap {
|
|
|
259
260
|
setStyle(theme: Theme): void;
|
|
260
261
|
setLanguage(lang: MapLanguage): void;
|
|
261
262
|
getMaps3DLayer(): IMaps3DLayer | undefined;
|
|
263
|
+
/** Вкл/выкл детальные 3D-здания (Maps3D). Работает только для engine: "3d". */
|
|
264
|
+
toggle3DBuildings(enabled: boolean): void;
|
|
262
265
|
setCenter(center: [number, number]): void;
|
|
263
266
|
setZoom(zoom: number): void;
|
|
264
267
|
destroy(): void;
|