d3-dag/dist/sugiyama/decross/opt.d.ts

Layout algorithms for visualizing directed acylic graphs.

/**
 * An {@link DecrossOpt} for optimally minimizing the number of crossings.
 *
 * @packageDocumentation
 */
import { Decross } from ".";
import { OptChecking } from "../../layout";
/**
 * a {@link Decross} that minimizes the number of crossings
 *
 * This method brute forces an NP-Complete problem, and as such may run for an
 * exceedingly long time on large graphs. As a result, any graph that is
 * probably too large will throw an error instead of running. Use with care.
 *
 * Create with {@link decrossOpt}.
 */
export interface DecrossOpt extends Decross<unknown, unknown> {
    /**
     * set how to check for large dags
     *
     * The default settings is set to error if the graph is too large.  If you
     * modify this, the layout may run forever, or may crash. See
     * {@link OptChecking} for more details.
     *
     * (default: `"fast"`)
     *
     * @example
     *
     * ```ts
     * const decross = decrossOpt().check("slow");
     * ```
     */
    check(val: OptChecking): DecrossOpt;
    /** get the current check for large graphs */
    check(): OptChecking;
    /**
     * set whether to also minimize distance between nodes that share an ancestor
     *
     * This setting adds more variables and constraints, and so will make the
     * decrossing step take longer, but will likely produce a better layout as
     * nodes that share common parents or children will be put closer together if
     * it doesn't affect the number of crossings. It is especially usefuly for
     * ancestry layoutss where nodes that share a child will inherently be put
     * closer together even if it doesn't reduce the number of crossings.
     *
     * (default: `false`)
     */
    dist(val: boolean): DecrossOpt;
    /** get whether the current layout minimized distance */
    dist(): boolean;
    /** @internal flag indicating that this is built in to d3dag and shouldn't error in specific instances */
    readonly d3dagBuiltin: true;
}
/**
 * create a default {@link DecrossOpt}
 *
 * This operator optimally reduces the number of edge crossings, and can
 * optionally reduce the distance between nodes that share a common ancestor.
 * This should produce the best layouts, but due to the complexity can only be
 * run on fairly small graphs.
 *
 * By default it's set to error if the graph is too large. You can relax if it
 * errors with {@link DecrossOpt#check}, but this isn't advised.
 *
 * @example
 * ```ts
 * const layout = sugiyama().decross(decrossOpt().dist(true));
 * ```
 */
export declare function decrossOpt(...args: never[]): DecrossOpt;