ts-graphviz
    Preparing search index...

    Interface RenderToDotOptions<Container>

    Rendering options for renderToDot

    interface RenderToDotOptions<
        Container extends AnyGraphContainer = AnyGraphContainer,
    > {
        container?: Container;
        onCaughtError?: (error: Error, errorInfo: ErrorInfo) => void;
        onRecoverableError?: (error: Error, errorInfo: ErrorInfo) => void;
        onRenderComplete?: (models: DotObjectModel<DotObjectType>[]) => void;
        onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void;
        timeout?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    container? onCaughtError? onRecoverableError? onRenderComplete? onUncaughtError? timeout?

    Properties

    container?: Container

    Container graph to render into. When provided, the element will be rendered as children of this container and the container's DOT will be returned.

    onCaughtError?: (error: Error, errorInfo: ErrorInfo) => void

    Called when an error is caught by an error boundary

    onRecoverableError?: (error: Error, errorInfo: ErrorInfo) => void

    Called when React automatically recovers from errors

    onRenderComplete?: (models: DotObjectModel<DotObjectType>[]) => void

    Called when rendering completes successfully

    onUncaughtError?: (error: Error, errorInfo: ErrorInfo) => void

    Called when an error is not caught by any error boundary

    timeout?: number

    Timeout for rendering in milliseconds.

    Rendering is synchronous, so the timeout does not interrupt it: a render that took longer rejects once its work is done.

    5000

    Settings

    Member Visibility

    On This Page

    Properties