@mapxus/mapxus-map-jp 7.2.0 → 7.4.0

package/README.md

@@ -16,22 +16,27 @@ import maplibregl from 'maplibre-gl';
 import * as MapxusMap from '@mapxus/mapxus-map';
 
 const maplibreMap = new maplibregl.Map({
-	container: 'map'
+	container: 'map',
+	zoom: 17,
 });
 
 const map = new MapxusMap.Map({
-    map: maplibreMap,
-    appId: 'your_appId',
-    secret: 'your_secret',
-    buildingId: 'building_id', // example: elements_hk_dc005f
+	map: maplibreMap,
+	appId: 'your_appId',
+	secret: 'your_secret',
+	buildingId: 'building_id', // example: elements_hk_dc005f
+	// or
+	// venueId: 'venue_id',
+	// floorId: 'floor_id',
+	// poiId: 'poi_id',
 });
 ```
 
-More sample page at [https://map-service.mapxus.co.jp/bssww/initMapByVenue](https://map-service.mapxus.co.jp/bssww/initMapByVenue)
+More sample page at [MapxusMap Sample Web](https://map-service.mapxus.co.jp/bssww/initMapByVenue)
 
 ## Documentation
 
-Docs are available at [https://map-service.mapxus.co.jp/dpw/digitalMapWeb](https://map-service.mapxus.co.jp/dpw/digitalMapWeb)
+Docs are available at [MapxusMap JS SDK API Docs](https://map-service.mapxus.co.jp/dpw/digitalMapWeb)
 
 ## License
 

package/index.d.ts

@@ -1,7 +1,7 @@
-// Generated by dts-bundle-generator v6.13.0
+// Generated by dts-bundle-generator v8.1.2
 
 import { AxiosPromise } from 'axios';
-import { ControlPosition, FilterSpecification, IControl, LngLat, Map as MaplibreMap, Map as maplibreMap, MapGeoJSONFeature, MapLayerEventType, PointLike } from 'maplibre-gl';
+import { ControlPosition, FilterSpecification, IControl, LngLat, Map as MaplibreMap, Map as maplibreMap, MapGeoJSONFeature, MapLayerEventType, PaddingOptions, PointLike, RequireAtLeastOne } from 'maplibre-gl';
 
 export declare enum ThemeType {
 	CHRISTMAS = "christmas",
@@ -36,17 +36,52 @@ export interface IMapOption {
 	secret: string;
 	enableFloorControl?: boolean;
 	enableBuildingSelector?: boolean;
+	/**
+	 * @description 'venueId', 'buildingId', 'floorId', 'poiId' are mutually exclusive,
+	 * the priority is: poiId > floorId > buildingId > venueId.
+	 */
 	venueId?: string;
+	/**
+	 * @description 'venueId', 'buildingId', 'floorId', 'poiId' are mutually exclusive,
+	 * the priority is: poiId > floorId > buildingId > venueId.
+	 */
 	buildingId?: string;
+	/**
+	 * @description 'venueId', 'buildingId', 'floorId', 'poiId' are mutually exclusive,
+	 * the priority is: poiId > floorId > buildingId > venueId.
+	 */
 	floorId?: string;
+	/**
+	 * @description Initialize the map with POI as the center point, use it with maplibregl.Map 'zoom' option.
+	 * 'venueId', 'buildingId', 'floorId', 'poiId' are mutually exclusive,
+	 * the priority is: poiId > floorId > buildingId > venueId.
+	 */
 	poiId?: string;
 	hiddenOutdoor?: boolean;
 	theme?: ThemeType;
 	collapseCopyright?: boolean;
 	selectedBuildingBorderStyle?: ISelectedBuildingBorderStyle;
 	floorsControlStyle?: IFloorsControlStyle;
+	/**
+	 * @description Switch floors by venue/building, default by venue.
+	 */
 	floorSwitchMode?: FloorSwitchMode;
+	/**
+	 * @description Whether unselected buildings are masked, default is false.
+	 */
 	maskNonSelectedAreas?: boolean;
+	/**
+	 * @description Whether the boundary of the selected building fits the screen, default is false.
+	 * Can only be used for 'floorId', 'buildingId' and 'venueId' initialization, not for 'poiId'.
+	 * When it is true, the 'boundsPadding' option is valid, and the 'zoom' option of maplibregl.Map is invalid.
+	 */
+	fitBuildingBounds?: boolean;
+	/**
+	 * @description The amount of padding in pixels to add to the given bounds, default is 30.
+	 * Requires 'fitBuildingBounds' to be 'true'.
+	 * Parameter value ref to: https://maplibre.org/maplibre-gl-js/docs/API/types/maplibregl.PaddingOptions/
+	 */
+	boundsPadding?: number | RequireAtLeastOne<PaddingOptions>;
 }
 export type Listener = (param: Object) => any;
 declare class DefinedEvent {
@@ -141,7 +176,19 @@ export declare class Indoor extends Evented {
 	private _upperLevelIds;
 	private _lowerLevelIds;
 	private _dispatch;
-	constructor(map: maplibreMap, isHiddenOutdoor?: boolean, floorSwitchMode?: FloorSwitchMode);
+	private readonly _fitBuildingBounds;
+	private readonly _boundsPadding;
+	private readonly _isInitialIndoor;
+	private _maplibreMapLoaded;
+	private _indoorMapLoaded;
+	constructor(props: {
+		map: maplibreMap;
+		isInitialIndoor: boolean;
+		isHiddenOutdoor: boolean;
+		floorSwitchMode: FloorSwitchMode;
+		fitBuildingBounds: boolean;
+		boundsPadding: number | RequireAtLeastOne<PaddingOptions>;
+	});
 	/**
 	 * @description Turn on indoor-outdoor switching.
 	 */
@@ -251,7 +298,7 @@ export declare class Indoor extends Evented {
 	private _getConditionsExpression;
 	private _loadData;
 	private _init;
-	private _load;
+	private _filter;
 	private _clear;
 	private _updateFilter;
 	private _setPoiTextColor;
@@ -325,7 +372,6 @@ export declare class Map extends Evented {
 	private _poi;
 	private _initialHiddenLayers;
 	private _attributionControl;
-	private _mapZoom;
 	private _dispatch;
 	constructor(option: IMapOption);
 	/**
@@ -389,6 +435,19 @@ export declare class Map extends Evented {
 	 * @return {MapGeoJSONFeature | undefined}
 	 */
 	getFeature(id: string): MapGeoJSONFeature | undefined;
+	/**
+	 * @description Get features from bbox by coordinates [and ordinal].
+	 * @param coordinates
+	 * @param ordinal
+	 */
+	getIndoorFeaturesByCoordinates(coordinates: {
+		lng: number;
+		lat: number;
+	}, ordinal?: number): {
+		venue: MapGeoJSONFeature;
+		building: MapGeoJSONFeature;
+		level: MapGeoJSONFeature;
+	};
 	/**
 	 * @description Get features from bbox by id. One id may correspond to multiple features.
 	 * @param id
@@ -408,7 +467,7 @@ export declare class Map extends Evented {
 	selectBuildingById(buildingId: string, callback?: VoidFunction): Promise<void>;
 	/**
 	 * @description Select or exit venue by id.
-	 * @param venueId Exit venue if venueId is null.
+	 * @param venueId 'venueId' can be string or null. Exit indoors if venueId is null.
 	 * @param callback Called after venue has been selected.
 	 */
 	selectVenueById(venueId: string | null, callback?: VoidFunction): Promise<void>;
@@ -481,9 +540,15 @@ export declare class Map extends Evented {
 	private _setIndoorFilter;
 	private _setStyle;
 	private _addControl;
-	private _defaultSetMapZoom;
 	private _selectPoiById;
 	private _getBuildingIdByVenueId;
+	private _tilesRequestTransform;
+	private _checkMapZoom;
+	private _setMapStyle;
+	private _clickEventsDispatcher;
+	private _hideIndoorLayers;
+	private _showIndoorLayers;
+	private _updatePermission;
 }
 export type TAnchorPosition = "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
 export declare class Marker {
@@ -501,7 +566,7 @@ export declare class Marker {
 	 * @param callback Called when the image(from an external URL) has loaded
 	 * or with an error argument if there is an error.
 	 */
-	setIconImage(icon: string, callback: VoidFunction): void;
+	setIconImage(icon: string, callback?: VoidFunction): void;
 	/**
 	 * @description Set marker by image url.
 	 * @deprecated Use 'setIconImage' instead.
@@ -563,8 +628,8 @@ export declare class Marker {
 	 * Required 'venueId' and 'ordinal' in properties.
 	 * Markers not matched 'venueId' and 'ordinal' would be hidden;
 	 * Outdoor markers always are shown.
-	 * @param venueId {string | null | undefined}
-	 * @param ordinal {string | null | undefined}
+	 * @param venueId {string | null | undefined} null | undefined will be treated as ''.
+	 * @param ordinal {string | null | undefined} null | undefined will be treated as ''.
 	 */
 	setFilterByVenue(venueId: string | null | undefined, ordinal: string | null | undefined): void;
 	/**
@@ -572,8 +637,8 @@ export declare class Marker {
 	 * Required 'buildingId' and 'ordinal' in properties.
 	 * Markers not matched 'buildingId' and 'ordinal' would be hidden;
 	 * Outdoor markers always are shown.
-	 * @param buildingId {string | null | undefined}
-	 * @param ordinal {string | null | undefined}
+	 * @param buildingId {string | null | undefined} null | undefined will be treated as ''.
+	 * @param ordinal {string | null | undefined} null | undefined will be treated as ''.
 	 */
 	setFilterByBuilding(buildingId: string | null | undefined, ordinal: string | null | undefined): void;
 	/**
@@ -588,8 +653,8 @@ export declare class Marker {
 	 * Required 'venueId' and 'ordinal' in properties.
 	 * Opacities of markers matched 'venueId' and 'ordinal' are 1, others are 0.5.
 	 * Outdoor markers' opacity always are 1.
-	 * @param venueId {string | null | undefined}
-	 * @param ordinal {string | null | undefined}
+	 * @param venueId {string | null | undefined} null | undefined will be treated as ''.
+	 * @param ordinal {string | null | undefined} null | undefined will be treated as ''.
 	 */
 	setOpacityByVenue(venueId: string | null | undefined, ordinal: string | null | undefined): void;
 	/**
@@ -597,8 +662,8 @@ export declare class Marker {
 	 * Required 'buildingId' and 'ordinal' in properties.
 	 * Opacities of markers matched 'buildingId' and 'ordinal' are 1, others are 0.5.
 	 * Outdoor markers' opacity always are 1.
-	 * @param buildingId {string | null | undefined}
-	 * @param ordinal {string | null | undefined}
+	 * @param buildingId {string | null | undefined} null | undefined will be treated as ''.
+	 * @param ordinal {string | null | undefined} null | undefined will be treated as ''.
 	 */
 	setOpacityByBuilding(buildingId: string | null | undefined, ordinal: string | null | undefined): void;
 	private _createIconFeature;
@@ -718,7 +783,7 @@ export type IMultiLangAddress = Record<keyof IMultiLangName, {
 }>;
 export interface IBbox {
 	maxLat: number;
-	maxLon: string;
+	maxLon: number;
 	minLat: number;
 	minLon: number;
 }
@@ -833,6 +898,7 @@ export declare class VenuesService {
 	 * @param page Default is 1.
 	 */
 	searchByGlobal(keywords: string, offset?: number, page?: number): AxiosPromise<IResponse<IResponseVenues>>;
+	private _changedRes;
 }
 export interface IResponseBuildings {
 	buildings: IBuilding[];
@@ -904,6 +970,11 @@ export interface IResponsePois {
 	pois: IPoi[];
 	total: number;
 }
+export declare enum DistanceSearchType {
+	POINT = "Point",
+	POLYGON = "Polygon",
+	GATE = "Gate"
+}
 export interface IPoiCategory {
 	category: string;
 	description: string;
@@ -970,25 +1041,45 @@ export declare class PoisService {
 	/**
 	 * @description Search poi categories by venue id, building id, or floor id.
 	 * Search scope priority: floorId > buildingId > venueId.
-	 * @param venueId
-	 * @param buildingId
-	 * @param floorId
+	 * @param paramObject
 	 */
-	searchCategories({ venueId, buildingId, floorId, }: {
+	searchCategories(paramObject: {
 		venueId?: string;
 		buildingId?: string;
 		floorId?: string;
 	}): AxiosPromise<IResponse<IPoiCategory[]>>;
 	/**
-	 * @description Search orientation and poi
-	 * @param angle The angle between cellphone's orientation and the north.
-	 * @param buildingId
-	 * @param center User's current position, [lon, lat].
-	 * @param distance Radius from center, unit is meter.
-	 * @param distanceSearchType Search type, default is DistanceSearchType.POINT.
-	 * @param floorId
+	 * @description Search orientation and poi.
+	 * BuildingId, floorId and ordinal are mutually exclusive, priority: ordinal > floorId > buildingId.
+	 * @param paramObj
 	 */
-	searchOrientation(angle: number, buildingId: string, center: number[], distance: number, distanceSearchType?: string, floorId?: string): AxiosPromise<IResponse<IOrientationPoi[]>>;
+	searchOrientation(paramObj: {
+		/**
+		 * User's current position, [lon, lat].
+		 */
+		center: [
+			number,
+			number
+		];
+		/**
+		 * The angle between cellphone's orientation and the north.
+		 */
+		angle: number;
+		/**
+		 * Radius.
+		 */
+		distance: number;
+		buildingId?: string;
+		floorId?: string;
+		/**
+		 * Floor order in physical space, e.g. '-1', '0'(ground floor), '1'...
+		 */
+		ordinal?: string;
+		/**
+		 * Search type.
+		 */
+		distanceSearchType?: DistanceSearchType;
+	}): AxiosPromise<IResponse<IOrientationPoi[]>>;
 	private _changedRes;
 }
 export interface IResponseRoute {
@@ -1115,7 +1206,7 @@ export declare class RoutePainter {
 	 */
 	setOutdoorLineColor(color: string): this;
 	/**
-	 * @description Set color of dashed line which connected the start and end markers.
+	 * @description Set color of dashed lines which connected the start and end markers.
 	 * @param color The color type is a color in the sRGB color space.
 	 * Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA.
 	 * Predefined HTML colors names, like yellow and blue, are also permitted.
@@ -1171,10 +1262,6 @@ export declare class RoutePainter {
 }
 export declare const OFFSET: number;
 export declare const PAGE: number;
-export declare enum DistanceSearchType {
-	POINT = "Point",
-	POLYGON = "Polygon"
-}
 export declare const version: string;
 export type { ControlPosition, Map as MaplibreMap, MapLayerEventType, FilterSpecification, PointLike, } from "maplibre-gl";