@geoapify/route-planner-sdk
Version:
TypeScript SDK for the Geoapify Route Planner API. Supports route optimization, delivery planning, and timeline visualization in browser and Node.js
61 lines (60 loc) • 2.89 kB
TypeScript
import { RoutePlannerResult, RoutePlannerTimelineOptions, RoutePlannerTimelineLabel, Timeline, TimelineMenuItem, RoutePlannerInputData } from "./models";
export declare class RoutePlannerTimeline {
private readonly WAYPOINT_POPUP_INITIALIZED_ATTRIBUTE;
private readonly WAYPOINT_POPUP_CONTAINER_ID;
defaultColors: string[];
timelineTemplate: (timeline: Timeline, index: number, timelineType: 'time' | 'distance', timeLabels: RoutePlannerTimelineLabel[], distanceLabels: RoutePlannerTimelineLabel[], agentMenuItems?: TimelineMenuItem[]) => string;
container: HTMLElement;
inputData?: RoutePlannerInputData;
result?: RoutePlannerResult;
options: RoutePlannerTimelineOptions;
waypointPopupContainer: HTMLElement | null;
eventListeners: {
[key: string]: Function[];
};
constructor(container: HTMLElement, inputData?: RoutePlannerInputData, result?: RoutePlannerResult, options?: RoutePlannerTimelineOptions);
getHasLargeDescription(): boolean | undefined;
setHasLargeDescription(value: boolean): void;
getTimelineType(): 'time' | 'distance' | undefined;
setTimelineType(value: 'time' | 'distance'): void;
getAgentColors(): string[] | undefined;
setAgentColors(value: string[]): void;
getCapacityUnit(): string | undefined;
setCapacityUnit(value: string | undefined): void;
getTimeLabels(): RoutePlannerTimelineLabel[] | undefined;
setTimeLabels(value: RoutePlannerTimelineLabel[]): void;
getShowTimelineLabels(): boolean | undefined;
setShowTimelineLabels(value: boolean): void;
getDistanceLabels(): RoutePlannerTimelineLabel[] | undefined;
setDistanceLabels(value: RoutePlannerTimelineLabel[]): void;
getAgentLabel(): string | undefined;
setAgentLabel(value: string): void;
getAgentMenuItems(): TimelineMenuItem[] | undefined;
setAgentMenuItems(value: TimelineMenuItem[]): void;
getResult(): RoutePlannerResult | undefined;
setResult(value: RoutePlannerResult): void;
on(eventName: string, handler: Function): void;
off(eventName: string, handler: Function): void;
getAgentColorByIndex(index: number): string;
private generateAgentTimeline;
private drawTimelines;
private generateTimelinesData;
private emit;
private generateItemsByTime;
private generateItemsByDistance;
private generateTimeLabels;
private generateDistanceLabels;
private getTimelineLabelsWidth;
private generateAgentDescription;
private initializeGlobalTooltip;
private createWaypointPopupContainer;
private initializeWaypointPopups;
private showWaypointPopup;
private hideWaypointPopup;
private initializeThreeDotMenus;
private generateAgentMenuItemsOnThreeDotClick;
private generateMenuItemsForAgent;
private updateMenuItems;
private toggleThreeDotMenu;
private closeAllThreeDotMenus;
}