@mapxus/mapxus-map-jp 7.10.0 → 8.0.0

package/es/index.d.ts

@@ -3,23 +3,25 @@
 import { AxiosPromise } from 'axios';
 import { GeoJsonProperties, LineString, Point } from 'geojson';
 import maplibregl$1 from 'maplibre-gl';
-import { ControlPosition, FilterSpecification, IControl, LngLat, MapGeoJSONFeature, MapLayerEventType, PaddingOptions, PointLike, RequireAtLeastOne } from 'maplibre-gl';
+import { ControlPosition, ExpressionSpecification, FilterSpecification, IControl, LngLat, MapGeoJSONFeature, MapLayerEventType, PaddingOptions, PointLike, RequireAtLeastOne } from 'maplibre-gl';
 
 /** @deprecated */
 export declare enum FloorSwitchMode {
 	SWITCHED_BY_BUILDING = 0,
 	SWITCHED_BY_VENUE = 1
 }
-/**
- * @deprecated Use enum `PresetLanguage` instead.
- */
-export type TPresetLanguage = "en" | "zh-Hans" | "zh-Hant" | "ja" | "ko";
 export declare enum PresetLanguage {
 	ENGLISH = "en",
 	CHINESE_SIMPLIFIED = "zh-Hans",
 	CHINESE_TRADITIONAL = "zh-Hant",
 	JAPANESE = "ja",
-	KOREAN = "ko"
+	KOREAN = "ko",
+	FILIPINO = "fil",
+	INDONESIAN = "id",
+	PORTUGUESE = "pt",
+	THAI = "th",
+	VIETNAMESE = "vi",
+	ARABIC = "ar"
 }
 export declare enum ThemeType {
 	CHRISTMAS = "christmas",
@@ -97,18 +99,6 @@ export interface IFloor {
 	id: string | null;
 	ordinal: string | null;
 }
-/**
- * @deprecated Use 'IFloorSelectorStyle' instead.
- */
-export interface IFloorsControlStyle {
-	fontColor?: string;
-	activeFontColor?: string;
-	backgroundColor?: string;
-	activeBackgroundColor?: string;
-	itemSize?: number;
-	itemCount?: number;
-	defaultFolded?: boolean;
-}
 export interface IFloorSelectorStyle {
 	fontColor?: string;
 	activeFontColor?: string;
@@ -133,11 +123,7 @@ export interface IMapOption {
 	map: maplibregl$1.Map;
 	appId: string;
 	secret: string;
-	/** @deprecated Use 'floorSelectorEnabled' instead */
-	enableFloorControl?: boolean;
 	floorSelectorEnabled?: boolean;
-	/** @deprecated Use 'buildingSelectorEnabled' instead */
-	enableBuildingSelector?: boolean;
 	buildingSelectorEnabled?: boolean;
 	/**
 	 * @description 'venueId', 'buildingId', 'floorId', 'poiId' are mutually exclusive,
@@ -160,18 +146,10 @@ export interface IMapOption {
 	 * the priority is: poiId > floorId > buildingId > venueId.
 	 */
 	poiId?: string;
-	/**
-	 * @deprecated Use 'outdoorMapShown' instead.
-	 */
-	hiddenOutdoor?: boolean;
 	outdoorMapShown?: boolean;
 	theme?: ThemeType | string;
 	collapseCopyright?: boolean;
 	selectedBuildingBorderStyle?: ISelectedBuildingBorderStyle;
-	/**
-	 * @deprecated Use 'floorSelectorStyle' instead.
-	 */
-	floorsControlStyle?: IFloorsControlStyle;
 	floorSelectorStyle?: IFloorSelectorStyle;
 	/**
 	 * @description Switch floors by venue/building, default by venue.
@@ -235,8 +213,6 @@ export interface IPoi {
 	osmRefId: number;
 	poiId: string;
 	venueId: string;
-	/** @deprecated 'description' will be removed soon */
-	description?: string;
 	descriptions?: IMultilingualName;
 	email?: string;
 	openingHours?: string;
@@ -345,33 +321,6 @@ export interface IPoiSearchByOrientationAndOrdinalOptions extends ISearchOrienta
 	ordinal: string;
 }
 export type TPoiSearchByOrientationOptions = IPoiSearchByOrientationAndBuildingOptions | IPoiSearchByOrientationAndFloorOptions | IPoiSearchByOrientationAndOrdinalOptions;
-export interface IPoiSearchOrientationOptions {
-	/**
-	 * User's current position, [lng, 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;
-}
 export declare enum PoisOrderBy {
 	DEFAULT_NAME = "DefaultName"
 }
@@ -491,8 +440,6 @@ export interface IRouteSearchOptions {
 	points: Array<{
 		lat: number;
 		lon: number;
-		/** @deprecated 'buildingId' will be removed in future versions */
-		buildingId?: string;
 		floorId?: string;
 	}>;
 	/**
@@ -503,11 +450,6 @@ export interface IRouteSearchOptions {
 	 * @description Language-specific response. Default is "en".
 	 */
 	locale?: PresetLanguage;
-	/**
-	 * @description Whether the end point of the route is at the door(otherwise in the room), default is "true".
-	 * @deprecated
-	 */
-	toDoor?: boolean;
 }
 export interface IVenueInlineBuilding {
 	buildingOutlineId: number;
@@ -591,8 +533,7 @@ declare class Event$1 {
 	get target(): Evented;
 	set target(target: Evented);
 }
-/** MixedEvent class */
-export declare class Evented {
+declare class Evented {
 	private _listeners;
 	private _oneTimeListeners;
 	private _eventedParent;
@@ -681,43 +622,15 @@ export declare class Indoor extends Evented {
 		fitBuildingBounds?: boolean;
 		boundsPadding?: number | RequireAtLeastOne<PaddingOptions>;
 		maskNonSelectedAreas?: boolean;
-		/**
-		 * @deprecated Use 'startWithIndoorView' instead.
-		 */
-		isInitialIndoor?: boolean;
 		startWithIndoorView?: boolean;
-		/**
-		 * @deprecated Use 'outdoorMapShown' instead.
-		 */
-		isHiddenOutdoor?: boolean;
 		outdoorMapShown?: boolean;
 		selectedBuildingBorderStyle?: ISelectedBuildingBorderStyle;
 	});
-	/**
-	 * @description Turn on indoor-outdoor switching.
-	 * @deprecated Use 'setAllowOutdoorSwitch(true)' instead.
-	 */
-	enableSwitch(): this;
-	/**
-	 * @description Turn off indoor-outdoor switching.
-	 * @deprecated Use 'setAllowOutdoorSwitch(false)' instead.
-	 */
-	disableSwitch(): this;
 	/**
 	 * @description Set whether to allow exiting building.
 	 * @param allow
 	 */
 	setAllowOutdoorSwitch(allow: boolean): this;
-	/**
-	 * @description Turn on building-building switching.
-	 * @deprecated Use 'setAllowBuildingSwitch(true)' instead.
-	 */
-	enableSwitchBuilding(): this;
-	/**
-	 * @description Turn off building-building switching.
-	 * @deprecated Use 'setAllowBuildingSwitch(false)' instead.
-	 */
-	disableSwitchBuilding(): this;
 	/**
 	 * @description Set whether to allow switching building.
 	 * @param allow
@@ -741,13 +654,6 @@ export declare class Indoor extends Evented {
 	 * @description Get the geo features of bbox.
 	 */
 	get features(): MapGeoJSONFeature[];
-	/**
-	 * @description Get specified feature of bbox by id.
-	 * @deprecated Use 'getFeaturesById' instead.
-	 * @param id
-	 * @return {MapGeoJSONFeature | undefined}
-	 */
-	getFeature(id: string): MapGeoJSONFeature | undefined;
 	/**
 	 * @description Get features from bbox by id.
 	 * @param id
@@ -757,24 +663,11 @@ export declare class Indoor extends Evented {
 		layerIds?: string[];
 		filter?: (feature: MapGeoJSONFeature) => boolean;
 	}): MapGeoJSONFeature[];
-	/**
-	 * @description Get level feature at the point
-	 * @deprecated
-	 * @param point
-	 * @return {MapGeoJSONFeature | null}
-	 */
-	getLevelByPoint(point: PointLike): MapGeoJSONFeature | null;
 	/**
 	 * @description Switch floor by ordinal.
 	 * @param ordinal
 	 */
 	switchFloorByOrdinal(ordinal: string | null): Promise<void>;
-	/**
-	 * @description Hide the outdoor layer.
-	 * @deprecated Use 'setOutdoorMapShown' instead.
-	 * @param isHiddenOutdoor
-	 */
-	hiddenOutdoorLayer(isHiddenOutdoor: boolean): void;
 	setOutdoorMapShown(shown: boolean): void;
 	/**
 	 * @description Update map layout.
@@ -785,12 +678,6 @@ export declare class Indoor extends Evented {
 	 * @param style {ISelectedBuildingBorderStyle | null}
 	 */
 	setSelectedBuildingBorderStyle(style: ISelectedBuildingBorderStyle | null): void;
-	/**
-	 * @description Set whether to cover the unselected venues/buildings.
-	 * @deprecated
-	 * @param mask Default is false.
-	 */
-	setMaskNonSelectedAreas(mask: boolean): void;
 	/**
 	 * @description Listen for the indoor map state, including the changes of venue, building and floor.
 	 * @param listener
@@ -949,16 +836,6 @@ export declare class FloorsControl implements IControl {
 	 * @param dragPan
 	 */
 	switchByOrdinal(ordinal: string, dragPan?: boolean): void;
-	/**
-	 * @deprecated
-	 * @param visible
-	 */
-	setVisibility(visible: boolean): void;
-	/**
-	 * @deprecated Use 'changePosition' instead.
-	 * @param position
-	 */
-	setPosition(position: ControlPosition): void;
 	changePosition(from: ControlPosition, to: ControlPosition, index?: number): void;
 	setStyle(style: Partial<IFloorSelectorStyle>): void;
 	private _setVisibility;
@@ -1064,11 +941,6 @@ declare class Map$1 extends Evented {
 	 * @description Get maplibre map instance.
 	 */
 	getMaplibre(): maplibregl$1.Map;
-	/**
-	 * @description Get maplibre map instance.
-	 * @deprecated Use 'getMaplibre' instead.
-	 */
-	getMap(): maplibregl$1.Map;
 	/**
 	 * @description Get current selected floor info.
 	 * @return {IFloor | null}
@@ -1084,55 +956,21 @@ declare class Map$1 extends Evented {
 	 * @return {MapGeoJSONFeature | null}
 	 */
 	get venue(): MapGeoJSONFeature | null;
-	/**
-	 * @description Translate POI name to the specified language.
-	 * @deprecated Use 'setLanguage' instead.
-	 * @param language Window.navigator.language.
-	 */
-	transformPoiTextFieldLanguage(language: string): void;
 	/**
 	 * @description Set map language.
 	 * @param language {PresetLanguage} convertBrowserLangToPresetLang(Window.navigator.language).
 	 */
 	setLanguage(language: PresetLanguage): void;
 	/**
-	 * @description Turn on indoor-outdoor switching.
-	 * @deprecated Use 'switchOutdoor.enable()' instead.
-	 */
-	enableSwitch(): this;
-	/**
-	 * @description Turn off indoor-outdoor switching.
-	 * @deprecated Use 'switchOutdoor.disable()' instead.
-	 */
-	disableSwitch(): this;
-	/**
-	 * @description Turn on building-building switching.
-	 * @deprecated Use 'switchBuilding.enable()' instead.
+	 * @description Get map language.
+	 * @return {PresetLanguage}
 	 */
-	enableSwitchBuilding(): this;
-	/**
-	 * @description Turn off building-building switching.
-	 * @deprecated Use 'switchBuilding.disable()' instead.
-	 */
-	disableSwitchBuilding(): this;
-	/**
-	 * @description Set outdoor layer to be shown or hidden.
-	 * @deprecated Use 'setOutdoorMapShown' instead.
-	 * @param isHidden True is hidden, false is shown.
-	 */
-	setOutdoorLayerHidden(isHidden: boolean): void;
+	getLanguage(): PresetLanguage;
 	/**
 	 * @description Set outdoor map to be shown or hidden.
 	 * @param shown
 	 */
 	setOutdoorMapShown(shown: boolean): void;
-	/**
-	 * @description Get feature in bbox by id.
-	 * @deprecated Use 'getFeaturesById' instead.
-	 * @param id
-	 * @return {MapGeoJSONFeature | undefined}
-	 */
-	getFeature(id: string): MapGeoJSONFeature | undefined;
 	/**
 	 * @description Get features from bbox by coordinates [and ordinal].
 	 * @param coordinates
@@ -1215,34 +1053,11 @@ declare class Map$1 extends Evented {
 	}) => void): {
 		unsubscribe: VoidFunction;
 	};
-	/**
-	 * @description Hide the BuildingSelector.
-	 * @deprecated Use 'buildingSelector.disable()' instead.
-	 */
-	disableBuildingSelector(): this;
-	/**
-	 * @description Show the BuildingSelector.
-	 * @deprecated Use 'buildingSelector.enable()' instead.
-	 * @param position
-	 */
-	enableBuildingSelector(position?: ControlPosition): this;
 	/**
 	 * @description Switch the map style
 	 * @param theme ThemeType | string(customized map style file name)
 	 */
 	switchTheme(theme: string): void;
-	/**
-	 * @description Set the floorsControl's style.
-	 * @deprecated Use 'setFloorSelectorStyle' instead.
-	 * @param style
-	 */
-	setFloorsControlStyle(style: IFloorsControlStyle): this;
-	/**
-	 * @description Set the FloorSelector's style.
-	 * @deprecated Use 'map.floorSelector.setStyle()' instead.
-	 * @param style
-	 */
-	setFloorSelectorStyle(style: IFloorSelectorStyle): this;
 	/**
 	 * @description Set the SelectedBuildingBorder's style. If set to null, the border will be invisible.
 	 * @param style {ISelectedBuildingBorderStyle | null}
@@ -1320,15 +1135,6 @@ export declare class Marker {
 	 * @description Remove marker[s] layer and source.
 	 */
 	remove(): void;
-	/**
-	 * @description Add marker event listener.
-	 * @deprecated Use 'on' method instead.
-	 * @param eventKey
-	 * @param callback
-	 */
-	onEventListener(eventKey: keyof MapLayerEventType, callback: (marker: MapGeoJSONFeature) => void): {
-		offEventListener: VoidFunction;
-	};
 	/**
 	 * @description Add marker event listener.
 	 * @param eventKey
@@ -1374,19 +1180,21 @@ 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} null | undefined will be treated as ''.
-	 * @param ordinal {string | null | undefined} null | undefined will be treated as ''.
+	 * @param venueId {string | null | undefined}
+	 * @param ordinal {string | null | undefined}
+	 * @param inactiveOpacity {number} The opacity of marker while it's NOT in current floor, default is 0.5.
 	 */
-	setOpacityByVenue(venueId: string | null | undefined, ordinal: string | null | undefined): void;
+	setOpacityByVenue(venueId: string | null | undefined, ordinal: string | null | undefined, inactiveOpacity?: number): void;
 	/**
 	 * @description Set marker's icon-opacity by buildingId and ordinal.
 	 * 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} null | undefined will be treated as ''.
-	 * @param ordinal {string | null | undefined} null | undefined will be treated as ''.
+	 * @param buildingId {string | null | undefined}
+	 * @param ordinal {string | null | undefined}
+	 * @param inactiveOpacity {number} The opacity of marker while it's NOT in current floor, default is 0.5.
 	 */
-	setOpacityByBuilding(buildingId: string | null | undefined, ordinal: string | null | undefined): void;
+	setOpacityByBuilding(buildingId: string | null | undefined, ordinal: string | null | undefined, inactiveOpacity?: number): void;
 	private _createIconFeature;
 	private _addIconSource;
 	private _addIconLayer;
@@ -1409,15 +1217,48 @@ export declare class Poi {
 	private _initPoiClick;
 	private _getFloorDataByFloorId;
 }
+export interface IRouteMarkers {
+	from: string | null;
+	to: string | null;
+	stops: Array<string | null> | null;
+}
+export interface IRouteStyle<T> {
+	indoorLineColor?: string | ExpressionSpecification;
+	outdoorLineColor?: string | ExpressionSpecification;
+	dashedLineColor?: string | ExpressionSpecification;
+	shuttleBusLineColor?: string | ExpressionSpecification;
+	lineWidth?: number | ExpressionSpecification;
+	dashedLineWidth?: number | ExpressionSpecification;
+	disableDashedLine?: boolean;
+	inactiveRouteOpacity?: number | ExpressionSpecification;
+	markers?: T;
+	markerIconSize?: number | ExpressionSpecification;
+	lineSymbol?: {
+		/**
+		 * @description Icon url or sprite name.
+		 */
+		image?: string | null;
+		size?: number | ExpressionSpecification;
+		spacing?: number | ExpressionSpecification;
+	};
+}
+export type TRouteStyleOptions = IRouteStyle<Partial<IRouteMarkers> | Array<string | null>>;
 export declare class RoutePainter {
 	private readonly _maplibreMap;
-	private _fromMarkerIcon;
-	private _toMarkerIcon;
-	private _stopMarkerIcons;
-	private _markerIconSize;
-	private _paintProperties;
-	constructor(maplibreMap: maplibregl$1.Map);
+	private _routeStyle;
+	private _styleDiffs;
+	private _filterBy;
+	private _curVenue;
+	private _curBuilding;
+	private _curOrdinal;
+	constructor(maplibreMap: maplibregl$1.Map, routeStyle?: TRouteStyleOptions);
+	/**
+	 * @description Set the style of the route.
+	 * @param routeStyle {TRouteStyleOptions | null} When null, reset to the initial style.
+	 */
+	setStyle(routeStyle: TRouteStyleOptions | null): Promise<void>;
 	/**
+	 * @deprecated Use 'setStyle' instead.
 	 * @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;}**}
 	 * Array of sprite names or URLs, or the object with specifying icon.
@@ -1433,11 +1274,13 @@ export declare class RoutePainter {
 		stops?: Array<string | null> | null;
 	}): Promise<void>;
 	/**
-	 * @description Set image icon scale.
-	 * @param size Default is 1.
+	 * @deprecated Use 'setStyle' instead.
+	 * @description Set all icons scale.
+	 * @param size number in range [0, ∞), default is 1.
 	 */
 	setMarkerIconSize(size: number): this;
 	/**
+	 * @deprecated Use 'setStyle' instead.
 	 * @description Set the route color of the indoor part.
 	 * @param color The color type is a color in the sRGB color space.
 	 * Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA.
@@ -1445,6 +1288,7 @@ export declare class RoutePainter {
 	 */
 	setIndoorLineColor(color: string): this;
 	/**
+	 * @deprecated Use 'setStyle' instead.
 	 * @description Set the route color of the outdoor part.
 	 * @param color The color type is a color in the sRGB color space.
 	 * Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA.
@@ -1452,6 +1296,7 @@ export declare class RoutePainter {
 	 */
 	setOutdoorLineColor(color: string): this;
 	/**
+	 * @deprecated Use 'setStyle' instead.
 	 * @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.
@@ -1459,6 +1304,7 @@ export declare class RoutePainter {
 	 */
 	setDashedLineColor(color: string): this;
 	/**
+	 * @deprecated Use 'setStyle' instead.
 	 * @description Set color of shuttle bus line.
 	 * @param color The color type is a color in the sRGB color space.
 	 * Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA.
@@ -1501,6 +1347,10 @@ export declare class RoutePainter {
 	private _addLineLayer;
 	private _addTriangleLayer;
 	private _addIconLayer;
+	private _updateStyleProperties;
+	private _loadMarkerIcons;
+	private _updateLayers;
+	private _filterRouteOpacity;
 }
 export declare class VenuesService {
 	private _api;
@@ -1602,45 +1452,18 @@ export declare class PoisService {
 	 * @param options {IPoiSearchByDistanceOptions}
 	 */
 	searchByDistance(options: IPoiSearchByDistanceOptions): TPromisePois;
-	/**
-	 * @description Search POIs in a bbox.
-	 * @deprecated Use searchByBounds instead.
-	 * @param keywords
-	 * @param bbox Rectangular area, [minLon, minLat, maxLon, maxLat].
-	 * @param offset The maximum value is 100, default is 10.
-	 * @param page Default is 1.
-	 */
-	searchByBbox(keywords: string, bbox: number[], offset?: number, page?: number): TPromisePois;
 	/**
 	 * @description Search POIs in a rectangular area.
 	 * @param options {IPoiSearchByBoundsOptions}
 	 * 'orderBy' cannot be used with 'keywords'.
 	 */
 	searchByBounds(options: IPoiSearchByBoundsOptions): TPromisePois;
-	/**
-	 * @description Search POIs of a building.
-	 * @deprecated Use searchByBuilding instead.
-	 * @param keywords
-	 * @param buildingId
-	 * @param offset The maximum value is 100, default is 10.
-	 * @param page Default is 1.
-	 */
-	searchByBuildingId(keywords: string, buildingId: string, offset?: number, page?: number): TPromisePois;
 	/**
 	 * @description Search POIs of a building.
 	 * @param options {IPoiSearchByBuildingOptions}
 	 * 'orderBy' cannot be used with 'keywords'.
 	 */
 	searchByBuilding(options: IPoiSearchByBuildingOptions): TPromisePois;
-	/**
-	 * @description Search POIs of a venue.
-	 * @deprecated Use searchByVenue instead.
-	 * @param keywords
-	 * @param venueId
-	 * @param offset
-	 * @param page
-	 */
-	searchByVenueId(keywords: string, venueId: string, offset?: number, page?: number): TPromisePois;
 	/**
 	 * @description Search POIs of a venue.
 	 * @param options {IPoiSearchByVenueOptions}
@@ -1658,13 +1481,6 @@ export declare class PoisService {
 	 * @param options
 	 */
 	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.
-	 * @deprecated Use searchByOrientation instead.
-	 * @param options
-	 */
-	searchOrientation(options: IPoiSearchOrientationOptions): TPromiseOrientationPois;
 	/**
 	 * @description Search surrounding POIs based on the user's location and orientation.
 	 * @param options {TPoiSearchByOrientationOptions}
@@ -1694,9 +1510,7 @@ export declare const PAGE: number;
  * @param language {string} window.navigator.language
  */
 export declare function convertBrowserLangToPresetLang(language: string): PresetLanguage | null;
-/** @deprecated Use `VERSION` instead. */
-export declare const version: string;
-export declare const VERSION: string;
+export declare function getIdentifier(): Promise<string>;
 
 export {
 	Map$1 as Map,