@mapxus/mapxus-map-jp 7.3.0 → 7.5.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.
Files changed (4) hide show
  1. package/README.md +17 -9
  2. package/index.d.ts +389 -185
  3. package/index.js +1 -10
  4. package/package.json +4 -4
package/README.md CHANGED
@@ -6,32 +6,40 @@ maplibre-gl
6
6
 
7
7
  ## Install
8
8
  ```
9
- npm install maplibre-gl @mapxus/mapxus-map-jp
9
+ npm install @mapxus/mapxus-map-jp
10
10
  ```
11
11
 
12
+ **Tips**: We do not recommend you install `maplibre-gl` by yourself. Each version of `@mapxus/mapxus-map-jp` uses a specific version of `maplibre-gl`,
13
+ `@mapxus/mapxus-map-jp` will automatically install it with the matched version.
14
+
12
15
  ## Example
13
16
  ```js
14
17
  import 'maplibre-gl/dist/maplibre-gl.css';
15
18
  import maplibregl from 'maplibre-gl';
16
- import * as MapxusMap from '@mapxus/mapxus-map';
19
+ import * as MapxusMap from '@mapxus/mapxus-map-jp';
17
20
 
18
21
  const maplibreMap = new maplibregl.Map({
19
- container: 'map'
22
+ container: 'map',
23
+ zoom: 17,
20
24
  });
21
25
 
22
26
  const map = new MapxusMap.Map({
23
- map: maplibreMap,
24
- appId: 'your_appId',
25
- secret: 'your_secret',
26
- buildingId: 'building_id', // example: elements_hk_dc005f
27
+ map: maplibreMap,
28
+ appId: 'your_appId',
29
+ secret: 'your_secret',
30
+ buildingId: 'building_id', // example: elements_hk_dc005f
31
+ // or
32
+ // venueId: 'venue_id',
33
+ // floorId: 'floor_id',
34
+ // poiId: 'poi_id',
27
35
  });
28
36
  ```
29
37
 
30
- More sample page at [https://map-service.mapxus.co.jp/bssww/initMapByVenue](https://map-service.mapxus.co.jp/bssww/initMapByVenue)
38
+ More sample page at [MapxusMap Sample Web](https://map-service.mapxus.co.jp/bssww/initMapByVenue)
31
39
 
32
40
  ## Documentation
33
41
 
34
- Docs are available at [https://map-service.mapxus.co.jp/dpw/digitalMapWeb](https://map-service.mapxus.co.jp/dpw/digitalMapWeb)
42
+ Docs are available at [MapxusMap JS SDK API Docs](https://map-service.mapxus.co.jp/dpw/digitalMapWeb)
35
43
 
36
44
  ## License
37
45