becomap 1.7.32 → 1.7.34
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/lib/becomap.js +1 -1
- package/lib/index.d.ts +41 -0
- package/package.json +1 -1
package/lib/index.d.ts
CHANGED
|
@@ -1073,6 +1073,47 @@ export interface BCMapView {
|
|
|
1073
1073
|
* @returns The current custom location ID, or null if not set.
|
|
1074
1074
|
*/
|
|
1075
1075
|
getCurrentCustomLocationId(): string | null;
|
|
1076
|
+
/**
|
|
1077
|
+
* Sets a footfall location for the map view, displaying a marker on the specified building location.
|
|
1078
|
+
* Multiple locations can have footfall markers simultaneously.
|
|
1079
|
+
* @param footfallLocationId - The ID of the building location to set as footfall location.
|
|
1080
|
+
* @param initialCount - Optional initial count value (defaults to 1).
|
|
1081
|
+
*/
|
|
1082
|
+
setFootfallLocation(footfallLocationId: string, initialCount?: number): void;
|
|
1083
|
+
/**
|
|
1084
|
+
* Gets all current footfall location IDs.
|
|
1085
|
+
* @returns Array of footfall location IDs.
|
|
1086
|
+
*/
|
|
1087
|
+
getFootfallLocationIds(): string[];
|
|
1088
|
+
/**
|
|
1089
|
+
* Updates the footfall count for a specific location.
|
|
1090
|
+
* @param locationId - The ID of the location to update.
|
|
1091
|
+
* @param newCount - The new count value to display.
|
|
1092
|
+
*/
|
|
1093
|
+
updateFootfallCount(locationId: string, newCount: number): void;
|
|
1094
|
+
/**
|
|
1095
|
+
* Starts a simulation that randomly updates the footfall count for a specific location.
|
|
1096
|
+
* Useful for demonstration purposes before real API integration.
|
|
1097
|
+
* @param locationId - The ID of the location to simulate.
|
|
1098
|
+
* @param minCount - Minimum count value (defaults to 1).
|
|
1099
|
+
* @param maxCount - Maximum count value (defaults to 50).
|
|
1100
|
+
* @param intervalMs - Update interval in milliseconds (defaults to 3000).
|
|
1101
|
+
*/
|
|
1102
|
+
startFootfallSimulation(locationId: string, minCount?: number, maxCount?: number, intervalMs?: number): void;
|
|
1103
|
+
/**
|
|
1104
|
+
* Stops the footfall count simulation for a specific location.
|
|
1105
|
+
* @param locationId - The ID of the location to stop simulation for.
|
|
1106
|
+
*/
|
|
1107
|
+
stopFootfallSimulation(locationId: string): void;
|
|
1108
|
+
/**
|
|
1109
|
+
* Stops all running footfall simulations.
|
|
1110
|
+
*/
|
|
1111
|
+
stopAllFootfallSimulations(): void;
|
|
1112
|
+
/**
|
|
1113
|
+
* Hides footfall marker(s) from the map and stops any running simulations.
|
|
1114
|
+
* @param locationId - Optional location ID. If provided, hides only that marker. If omitted, hides all markers.
|
|
1115
|
+
*/
|
|
1116
|
+
hideFootfallMarker(locationId?: string): void;
|
|
1076
1117
|
/**
|
|
1077
1118
|
* Retrieves amenity locations of a specific type, sorted by floor priority and distance from kiosk location.
|
|
1078
1119
|
* @param amenityType - The type of amenity to retrieve.
|