Skip to content

mermaid


Interface: CommonLayoutRendererDefinition<CoreResult, PreparedLayout, MeasureResult>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:77

Type Parameters

CoreResult

CoreResult = unknown

PreparedLayout

PreparedLayout = void

MeasureResult

MeasureResult = CommonLayoutMeasure

Properties

afterPaint()?

optional afterPaint: (data4Layout, context, coreResult) => void | Promise<void>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:99

Parameters

data4Layout

LayoutData

context

CommonLayoutPaintContext<PreparedLayout, MeasureResult>

coreResult

CoreResult

Returns

void | Promise<void>


measureLayout()?

optional measureLayout: (data4Layout, context) => Promise<MeasureResult>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:86

Parameters

data4Layout

LayoutData

context

CommonLayoutRenderContext<PreparedLayout>

Returns

Promise<MeasureResult>


paintLayout()?

optional paintLayout: (data4Layout, context, coreResult) => void | Promise<void>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:94

Parameters

data4Layout

LayoutData

context

CommonLayoutPaintContext<PreparedLayout, MeasureResult>

coreResult

CoreResult

Returns

void | Promise<void>


paintOptions?

optional paintOptions: CommonLayoutPaintOptions

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:104


prepareLayout()?

optional prepareLayout: (data4Layout, context) => PreparedLayout | Promise<PreparedLayout>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:82

Parameters

data4Layout

LayoutData

context

CommonLayoutRenderContext<PreparedLayout>

Returns

PreparedLayout | Promise<PreparedLayout>


runLayoutCore()

runLayoutCore: (data4Layout, context) => CoreResult | Promise<CoreResult>

Defined in: packages/mermaid/src/rendering-util/layout-algorithms/common/index.ts:90

Parameters

data4Layout

LayoutData

context

CommonLayoutRenderContext<PreparedLayout>

Returns

CoreResult | Promise<CoreResult>

Opens in mermaid.ai