Skip to content

Typed API (TypeDoc)


Typed API (TypeDoc) / VertexEmitter

Class: VertexEmitter<VertexData, RenderReturnType, RenderContext>

Defined in: graph/src/emitter/generic.ts:16

Extended by

Type Parameters

VertexData

VertexData = Record<string, any>

RenderReturnType

RenderReturnType = Record<string, any> | undefined

RenderContext

RenderContext extends EmitterContext = EmitterContext

Constructors

Constructor

new VertexEmitter<VertexData, RenderReturnType, RenderContext>(): VertexEmitter<VertexData, RenderReturnType, RenderContext>

Defined in: graph/src/emitter/generic.ts:19

Returns

VertexEmitter<VertexData, RenderReturnType, RenderContext>

Properties

renderers

readonly renderers: NodeRenderer<VertexData, RenderReturnType | undefined, RenderContext, IVertex<VertexData>>[] = []

Defined in: graph/src/emitter/generic.ts:17

Methods

emit()

emit(vertex, ctx?): RenderReturnType | undefined

Defined in: graph/src/emitter/generic.ts:29

Parameters

vertex

IVertex<VertexData>

ctx?

RenderContext

Returns

RenderReturnType | undefined


emitAll()

emitAll(graph, ctx?): RenderReturnType[]

Defined in: graph/src/emitter/generic.ts:37

Parameters

graph

IGraph<VertexData, IVertex<VertexData>, IEdge<VertexData>, any>

ctx?

RenderContext

Returns

RenderReturnType[]


register()

register(renderer): void

Defined in: graph/src/emitter/generic.ts:22

Parameters

renderer

NodeRenderer<VertexData, RenderReturnType | undefined, RenderContext>

Returns

void

Built with VitePress – Released under the MIT License.