pddl-gantt/dist/DomainVizConfiguration.d.ts

Plan visualization for AI-Planning plans. The package includes HTML components for Gantt, swimlane and line plot visualization of plan originating from AI Planning solvers.

import { PlanStep } from "pddl-workspace";
import { CustomVisualization } from "./CustomVisualization";
/** Configures the plan/state visualization for this domain. */
export interface DomainVizConfiguration {
    /**
     * Decides whether given plan step shall be visualized.
     * @param planStep plan step
     */
    shouldDisplay(planStep: PlanStep): boolean;
    /**
     * Decides, whether objects should be hidden from swim-lanes based on the action/parameters they are involved in.
     * @param actionName action name e.g. 'drive'
     * @param parameterName action parameter name e.g. 'from'
     */
    shouldIgnoreActionParameter(actionName: string, parameterName: string): boolean;
    /** @returns JavaScript source to evaluate */
    getCustomVisualizationScript(): string | Promise<string | undefined>;
    /** @returns path to JavaScript file to load and execute */
    getCustomVisualizationScriptPath(): string | undefined;
    /** @returns custom visualization logic */
    getCustomVisualization(): Promise<CustomVisualization | undefined>;
}