@knowvah/dot-engine

Appearance

Class: GvcContext ​

Defined in: gvc/context.ts:176

Root Graphviz context. Owns the plugin registry, text measurer, and the layout-engine dispatch.

Counterpart of GVC_t in lib/gvc/gvcint.h.

See ​

lib/gvc/gvc.h:gvContext

Constructors ​

Constructor ​

ts
new GvcContext(measurer: TextMeasurer, options?: {
  debug?: DebugOptions;
}): GvcContext;

Defined in: gvc/context.ts:183

Parameters ​

measurer ​

TextMeasurer

options? ​
debug? ​

DebugOptions

Returns ​

GvcContext

Properties ​

debug ​

ts
readonly debug: DebugOptions | undefined;

Defined in: gvc/context.ts:181

textMeasurer ​

ts
textMeasurer: TextMeasurer;

Defined in: gvc/context.ts:180

Methods ​

bestRenderer() ​

ts
bestRenderer(format: string): RendererPlugin;

Defined in: gvc/context.ts:208

Return the first registered renderer whose type prefix matches format. Because renderers are sorted quality-descending within a prefix, the first match is always the highest-quality one (last-registered wins on tie).

Parameters ​

format ​

string

Returns ​

RendererPlugin

Throws ​

Error if no renderer is registered for format

See ​

lib/gvc/gvplugin.c:gvplugin_find

freeLayout() ​

ts
freeLayout(g: Graph, engineName: EngineName): void;

Defined in: gvc/context.ts:253

Release engine layout state after rendering.

Parameters ​

g ​

Graph

engineName ​

EngineName

Returns ​

void

Throws ​

Error if the engine is not registered

See ​

lib/gvc/gvlayout.c:gvFreeLayout

layout() ​

ts
layout(g: Graph, engineName: EngineName): void;

Defined in: gvc/context.ts:224

Run layout on g using engineName. Engine cleanup is deferred to freeLayout, matching C's gvLayoutJobs / gvFreeLayout split — rendering happens in between and must see the layout state (e.g. cluster arrays).

Parameters ​

g ​

Graph

engineName ​

EngineName

Returns ​

void

Throws ​

Error if the engine is not registered

See ​

lib/gvc/gvlayout.c:gvLayoutJobs

register() ​

Call Signature ​

ts
register(p: RendererPlugin): void;

Defined in: gvc/context.ts:189

Register a renderer or layout engine; overload discriminated by quality.

Parameters ​
p ​

RendererPlugin

Returns ​

void

Call Signature ​

ts
register(p: LayoutEngine): void;

Defined in: gvc/context.ts:190

Register a renderer or layout engine; overload discriminated by quality.

Parameters ​
p ​

LayoutEngine

Returns ​

void