@mapxus/mapxus-map-jp 7.8.0 → 7.10.0

package/es/index.d.ts

@@ -3,8 +3,9 @@
 import { AxiosPromise } from 'axios';
 import { GeoJsonProperties, LineString, Point } from 'geojson';
 import maplibregl$1 from 'maplibre-gl';
-import { ControlPosition, FilterSpecification, IControl, LngLat, Map as MaplibreMap, MapGeoJSONFeature, MapLayerEventType, PaddingOptions, PointLike, RequireAtLeastOne } from 'maplibre-gl';
+import { ControlPosition, FilterSpecification, IControl, LngLat, MapGeoJSONFeature, MapLayerEventType, PaddingOptions, PointLike, RequireAtLeastOne } from 'maplibre-gl';
 
+/** @deprecated */
 export declare enum FloorSwitchMode {
 	SWITCHED_BY_BUILDING = 0,
 	SWITCHED_BY_VENUE = 1
@@ -38,6 +39,7 @@ export interface IBbox {
 export interface IBuildingChangedOptions {
 	buildingId: string | null;
 	ordinal: string | null;
+	dragPan: boolean | "restrict";
 }
 export interface IMultilingualName extends Partial<Record<PresetLanguage, string>> {
 	default: string;
@@ -173,6 +175,7 @@ export interface IMapOption {
 	floorSelectorStyle?: IFloorSelectorStyle;
 	/**
 	 * @description Switch floors by venue/building, default by venue.
+	 * @deprecated 'floorSwitchMode' will be removed soon.
 	 */
 	floorSwitchMode?: FloorSwitchMode;
 	/**
@@ -192,6 +195,8 @@ export interface IMapOption {
 	 */
 	boundsPadding?: number | RequireAtLeastOne<PaddingOptions>;
 	language?: PresetLanguage;
+	/** @description Auto Select Building by panning building to map center, default is false. */
+	autoSelectBuilding?: boolean;
 }
 export type TAnchorPosition = "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
 export interface IMarkerOptions {
@@ -486,6 +491,7 @@ export interface IRouteSearchOptions {
 	points: Array<{
 		lat: number;
 		lon: number;
+		/** @deprecated 'buildingId' will be removed in future versions */
 		buildingId?: string;
 		floorId?: string;
 	}>;
@@ -549,6 +555,32 @@ export interface IResponseVenues {
 	total: number;
 }
 export type TPromiseVenues = AxiosPromise<IResponse<IResponseVenues>>;
+export interface IBoundsSpec {
+	/** An array of LngLat coordinates in [sw, ne] order */
+	bounds: [
+		[
+			number,
+			number
+		],
+		[
+			number,
+			number
+		]
+	];
+}
+export interface IKeywordSpec {
+	keywords?: string;
+}
+export interface IBuildingSpec {
+	buildingId: string;
+}
+export interface IVenueSpec {
+	venueId: string;
+}
+export interface IFloorSpec {
+	floorId: string;
+}
+export type TSearchCategoriesOptions = IVenueSpec | IBuildingSpec | IFloorSpec | (IBoundsSpec & IKeywordSpec);
 export type Listener = (param: any) => any;
 declare class Event$1 {
 	private _type;
@@ -631,16 +663,20 @@ export declare class Indoor extends Evented {
 	private _indoorMapLoaded;
 	private readonly _isVenueMode;
 	private _isMaskMode;
-	private _upperBuildings;
-	private _lowerBuildings;
-	private readonly _hiddenBuildings;
 	private _upperLevels;
 	private _lowerLevels;
-	private _history;
 	private _featureIncomplete;
-	private _isSwitchBuildingByClickMap;
+	private _dragPan;
+	private _isNewBuilding;
+	private _buildingBounds;
+	private _history;
+	private _layerBuildings;
+	private _upperBuildings;
+	private _lowerBuildings;
+	private readonly _hiddenBuildings;
 	constructor(props: {
-		map: MaplibreMap;
+		map: maplibregl$1.Map;
+		/** @deprecated */
 		floorSwitchMode?: FloorSwitchMode;
 		fitBuildingBounds?: boolean;
 		boundsPadding?: number | RequireAtLeastOne<PaddingOptions>;
@@ -723,24 +759,16 @@ export declare class Indoor extends Evented {
 	}): MapGeoJSONFeature[];
 	/**
 	 * @description Get level feature at the point
+	 * @deprecated
 	 * @param point
 	 * @return {MapGeoJSONFeature | null}
 	 */
 	getLevelByPoint(point: PointLike): MapGeoJSONFeature | null;
-	/**
-	 * @description Map pan to the building center and select the building.
-	 * @param buildingId
-	 * @param floorId
-	 * @param callback - **@deprecated** The optional parameter **'callback' will be removed soon**, you
-	 * should use this method as `await panToBuilding(buildingId)` or `panToBuilding(buildingId).then()`
-	 */
-	panToBuilding(buildingId: string, floorId?: string, callback?: (feature: MapGeoJSONFeature) => void): Promise<void>;
 	/**
 	 * @description Switch floor by ordinal.
 	 * @param ordinal
-	 * @param dragPan
 	 */
-	switchFloorByOrdinal(ordinal: string | null, dragPan?: boolean): void;
+	switchFloorByOrdinal(ordinal: string | null): Promise<void>;
 	/**
 	 * @description Hide the outdoor layer.
 	 * @deprecated Use 'setOutdoorMapShown' instead.
@@ -784,7 +812,20 @@ export declare class Indoor extends Evented {
 		featureIncomplete?: boolean;
 	}): Promise<void>;
 	updateRendering(): void;
-	private _getBuildingByPoint;
+	panToBuildingCenter(): Promise<unknown>;
+	fitBuildingBbox(): void;
+	setDragPan(dragPan: boolean | "restrict"): void;
+	setBuildingBounds(bounds: [
+		[
+			number,
+			number
+		],
+		[
+			number,
+			number
+		]
+	]): void;
+	selectBuildingByClickMap(point: PointLike): Promise<void>;
 	private _loadData;
 	private _init;
 	private _clear;
@@ -801,6 +842,7 @@ export declare class Indoor extends Evented {
 	private _getBuildingDefaultOrdinal;
 	private _getBuildingsOfBbox;
 	private _copyOverlapLayers;
+	private _updateFeatures;
 	private _layerDisplayedBuildings;
 	private _setDisplayedLevels;
 	private _filterTiles;
@@ -814,12 +856,11 @@ export declare class Indoor extends Evented {
 export declare class BuildingFilterControl implements IControl {
 	private _map;
 	private _maplibre;
-	private _indoor;
 	private _buildingId;
 	private _features;
-	private _container;
-	private _buildingNameLayout;
-	private _buildingNameList;
+	private _$container;
+	private _$listContainer;
+	private _$buildingList;
 	private _listHeight;
 	private _visible;
 	private _position;
@@ -829,7 +870,7 @@ export declare class BuildingFilterControl implements IControl {
 	 * @param buildingSelectorEnabled
 	 */
 	constructor(map: Map$1, position?: ControlPosition, buildingSelectorEnabled?: boolean);
-	onAdd(map: MaplibreMap): HTMLElement;
+	onAdd(map: maplibregl$1.Map): HTMLElement;
 	onRemove(): void;
 	get position(): ControlPosition;
 	get enabled(): boolean;
@@ -850,7 +891,6 @@ export declare class BuildingFilterControl implements IControl {
 	private _loadData;
 	private _init;
 	private _refresh;
-	private _select;
 	private _load;
 	private _buildingFilterIconCreate;
 	private _buildingNameListCreate;
@@ -897,7 +937,7 @@ export declare class FloorsControl implements IControl {
 	 * @param options
 	 */
 	constructor(indoor: Indoor, options: IFloorSelectorOptions);
-	onAdd(map: MaplibreMap): HTMLElement;
+	onAdd(map: maplibregl$1.Map): HTMLElement;
 	onRemove(): void;
 	get position(): ControlPosition;
 	get enabled(): boolean;
@@ -906,8 +946,9 @@ export declare class FloorsControl implements IControl {
 	/**
 	 * @description Switch floor by ordinal
 	 * @param ordinal
+	 * @param dragPan
 	 */
-	switchByOrdinal(ordinal: string): void;
+	switchByOrdinal(ordinal: string, dragPan?: boolean): void;
 	/**
 	 * @deprecated
 	 * @param visible
@@ -920,7 +961,6 @@ export declare class FloorsControl implements IControl {
 	setPosition(position: ControlPosition): void;
 	changePosition(from: ControlPosition, to: ControlPosition, index?: number): void;
 	setStyle(style: Partial<IFloorSelectorStyle>): void;
-	setDragPan(dragPan: boolean | undefined): void;
 	private _setVisibility;
 	private _bindEvents;
 	private _addMapMoveEventListener;
@@ -1004,9 +1044,8 @@ declare class Map$1 extends Evented {
 	private _language;
 	private _dispatch;
 	private _fitBuildingBounds;
-	private _boundsPadding;
-	private _buildingService;
-	private _venueService;
+	private _history;
+	private _hiddenBuildings;
 	switchOutdoor: SwitchOutdoorHandler;
 	switchBuilding: SwitchBuildingHandler;
 	buildingSelector: BuildingSelectorHandler;
@@ -1118,7 +1157,7 @@ declare class Map$1 extends Evented {
 		filter?: (feature: MapGeoJSONFeature) => boolean;
 	}): MapGeoJSONFeature[];
 	/**
-	 * @description Select floor by id.
+	 * @description Select indoor by locating the target floor.
 	 * @param floorId
 	 * @param options {dragPan: boolean} Set dragPan to be false, the map will not pan to the building center.
 	 * Default is true.
@@ -1127,7 +1166,7 @@ declare class Map$1 extends Evented {
 		dragPan?: boolean;
 	}): Promise<void>;
 	/**
-	 * @description Select building by id.
+	 * @description Select indoor by locating the target building.
 	 * @param buildingId
 	 * @param options {dragPan: boolean} Set dragPan to be false, the map will not pan to the building center.
 	 * Default is true.
@@ -1136,7 +1175,7 @@ declare class Map$1 extends Evented {
 		dragPan?: boolean;
 	}): Promise<void>;
 	/**
-	 * @description Select or exit venue by id.
+	 * @description Select indoor by locating the target venue.
 	 * @param venueId 'venueId' can be string or null. Exit indoors if venueId is null.
 	 * @param options {dragPan: boolean} Set dragPan to be false, the map will not pan to the building center.
 	 * Default is true.
@@ -1216,11 +1255,15 @@ declare class Map$1 extends Evented {
 	private _selectPoiById;
 	private _resourceRequestTransform;
 	private _checkMapZoom;
-	private _clickEventsDispatcher;
 	private _hideIndoorLayers;
 	private _showIndoorLayers;
 	private _updatePermission;
-	private _panToBuilding;
+	private _selectCenterBuilding;
+	/**
+	 * @description Query building features within the center rectangle(width: 1/2 width of map view, height: 1/2 height of map view) of map.
+	 * @returns Map<buildingId, buildingFeature>
+	 */
+	private _getCenterBuildingsMap;
 }
 export declare class Marker {
 	private readonly _maplibreMap;
@@ -1229,7 +1272,7 @@ export declare class Marker {
 	private _imageName;
 	private _imageSize;
 	private _iconAnchor;
-	constructor(maplibreMap: MaplibreMap);
+	constructor(maplibreMap: maplibregl$1.Map);
 	/**
 	 * @description Set custom marker image.
 	 * @param icon Sprite name in map style or the URL of the image file.
@@ -1292,7 +1335,7 @@ export declare class Marker {
 	 * @param callback
 	 */
 	on(eventKey: keyof MapLayerEventType, callback: (marker: MapGeoJSONFeature) => void): {
-		off: () => MaplibreMap;
+		off: () => maplibregl$1.Map;
 	};
 	/**
 	 * @description Filter marker by custom properties.
@@ -1353,7 +1396,7 @@ export declare class Poi {
 	private _map;
 	private _layerIds;
 	private _dispatch;
-	constructor(map: MaplibreMap);
+	constructor(map: maplibregl$1.Map);
 	/**
 	 * @description Listen for POI click events.
 	 * @param listener
@@ -1373,7 +1416,7 @@ export declare class RoutePainter {
 	private _stopMarkerIcons;
 	private _markerIconSize;
 	private _paintProperties;
-	constructor(maplibreMap: MaplibreMap);
+	constructor(maplibreMap: maplibregl$1.Map);
 	/**
 	 * @description Set image[s] of the stop marker[s].
 	 * @param icons {**Array<string | null> | {from?: string | null; to?: string | null; stops?: Array<string | null> | null;}**}
@@ -1545,7 +1588,8 @@ export declare class BuildingsService {
 export declare class PoisService {
 	private _api;
 	private _apiV4;
-	private _categoriesV2;
+	private _categoriesApi;
+	private _categoriesGroupApi;
 	private _request;
 	constructor();
 	/**
@@ -1610,15 +1654,10 @@ export declare class PoisService {
 	 */
 	searchByFloor(options: IPoiSearchByFloorOptions): TPromisePois;
 	/**
-	 * @description Search poi categories by venue id, building id, or floor id.
-	 * Search scope priority: floorId > buildingId > venueId.
-	 * @param paramObject
+	 * @description Search poi categories by venue/building/floor/bounds.
+	 * @param options
 	 */
-	searchCategories(paramObject: {
-		venueId?: string;
-		buildingId?: string;
-		floorId?: string;
-	}): TPromiseCategories;
+	searchCategories(options: TSearchCategoriesOptions): TPromiseCategories;
 	/**
 	 * @description Search surrounding POIs based on the user's location and orientation.
 	 * BuildingId, floorId and ordinal are mutually exclusive, priority: ordinal > floorId > buildingId.