becomap 1.6.99 → 1.7.1
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 +12 -2
- package/package.json +1 -1
package/lib/index.d.ts
CHANGED
|
@@ -611,8 +611,12 @@ export interface BCRouteController {
|
|
|
611
611
|
*
|
|
612
612
|
* @param segment - The BCRouteSegment object representing the route to be walked through.
|
|
613
613
|
* This object contains the sequence of steps that define the route.
|
|
614
|
+
* @param options - Optional configuration for the walkthrough animation
|
|
615
|
+
* @param options.cameraZoom - Optional zoom level for the camera during step animations (default: auto-calculated by fitBounds)
|
|
614
616
|
*/
|
|
615
|
-
walkThrough(segment: BCRouteSegment
|
|
617
|
+
walkThrough(segment: BCRouteSegment, options?: {
|
|
618
|
+
cameraZoom?: number;
|
|
619
|
+
}): void;
|
|
616
620
|
/**
|
|
617
621
|
* Stops the ongoing walkthrough of the route segment.
|
|
618
622
|
*/
|
|
@@ -629,12 +633,18 @@ export interface BCRouteController {
|
|
|
629
633
|
* contains information about the node, the action to be taken, the direction,
|
|
630
634
|
* and other relevant details that can be used to visually represent the step
|
|
631
635
|
* on the map.
|
|
636
|
+
* @param options - Optional configuration for the step display
|
|
637
|
+
* @param options.cameraZoom - Optional zoom level for the camera (default: auto-calculated by fitBounds)
|
|
638
|
+
* @param options.bufferDistance - Optional buffer distance in meters to expand the view area (default: 5)
|
|
632
639
|
*
|
|
633
640
|
* @example
|
|
634
641
|
* const routeStep: BCRouteStep = /obtain the step from a route segment/;
|
|
635
642
|
* this.showStep(routeStep);
|
|
636
643
|
*/
|
|
637
|
-
showStep(step: BCRouteStep
|
|
644
|
+
showStep(step: BCRouteStep, options?: {
|
|
645
|
+
cameraZoom?: number;
|
|
646
|
+
bufferDistance?: number;
|
|
647
|
+
}): void;
|
|
638
648
|
/**
|
|
639
649
|
* Shows the route step by its orderIndex.
|
|
640
650
|
* @param orderIndex - The order index of the step to display.
|