@ghentcdh/annotated-text / RenderParams

Type Alias: RenderParams<ANNOTATION>

RenderParams<ANNOTATION> = object

Defined in: libs/core/src/lib/adapter/annotation/renderer/annotation-render.ts:33

Configuration parameters for the annotation rendering system.

Type Parameters

ANNOTATION

ANNOTATION

The type of annotation objects being rendered

Properties

defaultRenderer

defaultRenderer: "gutter" | "highlight" | "underline" | string

Defined in: libs/core/src/lib/adapter/annotation/renderer/annotation-render.ts:42

Default renderer to use when renderFn returns null or undefined. Can be a built-in renderer name ('gutter', 'highlight', 'underline') or a custom registered renderer name.

Example

defaultRenderer: 'highlight'

---

renderFn()

renderFn: (annotation) => "gutter" | "highlight" | "underline" | string | null

Defined in: libs/core/src/lib/adapter/annotation/renderer/annotation-render.ts:70

Function that returns the renderer identifier for a given annotation. The returned string should match a registered renderer name. Return null to use the defaultRenderer.

Parameters

annotation

ANNOTATION

The annotation to get the renderer for

Returns

"gutter" | "highlight" | "underline" | string | null

The renderer identifier or null

Example

renderFn: (annotation) => annotation.renderer
// Returns 'highlight', 'underline', 'gutter', etc.

---

styleFn()

styleFn: (annotation) => string | null

Defined in: libs/core/src/lib/adapter/annotation/renderer/annotation-render.ts:56

Function that returns the style identifier for a given annotation. The returned string should match a registered style name. Return null to use the default style.

Parameters

annotation

any

The annotation to get the style for

Returns

string | null

The style identifier or null

Example

styleFn: (annotation) => annotation.style
// Returns 'annotation-color-1', 'primary', etc.