@ghentcdh/annotated-text / WordSnapper

Class: WordSnapper

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:21

Extends

• DefaultSnapper

Constructors

Constructor

new WordSnapper(tokenizer): WordSnapper

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:26

Parameters

tokenizer

Tokenizer = defaultTokenizr

Returns

WordSnapper

Overrides

DefaultSnapper.constructor

Properties

offsetStart

protected offsetStart: number = 0

Defined in: libs/core/src/lib/adapter/text/snapper/snapper.ts:19

Inherited from

DefaultSnapper.offsetStart

---

text

protected text: string = ''

Defined in: libs/core/src/lib/adapter/text/snapper/snapper.ts:18

Inherited from

DefaultSnapper.text

---

textLength

protected textLength: number = 0

Defined in: libs/core/src/lib/adapter/text/snapper/snapper.ts:20

Inherited from

DefaultSnapper.textLength

Methods

findClosestWord()

protected findClosestWord(position): WordPosition

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:242

Find the closest word to the given position.

Parameters

position

number

Returns

WordPosition

---

findClosestWordEnd()

protected findClosestWordEnd(position): number

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:224

Find the closest word end to the given position.

Parameters

position

number

Returns

number

---

findClosestWordStart()

protected findClosestWordStart(position): number

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:206

Find the closest word start to the given position.

Parameters

position

number

Returns

number

---

findNextWord()

protected findNextWord(currentWord): WordPosition

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:188

Find the word after the given word.

Parameters

currentWord

WordPosition

Returns

WordPosition

---

findPreviousWord()

protected findPreviousWord(currentWord): WordPosition

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:198

Find the word before the given word.

Parameters

currentWord

WordPosition

Returns

WordPosition

---

findWordContaining()

protected findWordContaining(position): WordPosition

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:168

Find the word containing the given position (inclusive bounds).

Parameters

position

number

Returns

WordPosition

---

fixOffset()

fixOffset(annotation): SnapperResult

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:74

Parameters

annotation

_drawMetadata

{ color?: { active: { border?: string; borderWidth: number; fill?: string; }; default: { border?: string; borderWidth: number; fill?: string; }; edit: { border?: string; borderWidth: number; fill?: string; }; hover: { border?: string; borderWidth: number; fill?: string; }; tag: { border?: string; borderWidth: number; fill?: string; text?: string; }; }; dimensions?: { x: number; y1: number; y2: number; }; draws: object[]; } = annotationDrawMetadataSchema

_drawMetadata.color?

{ active: { border?: string; borderWidth: number; fill?: string; }; default: { border?: string; borderWidth: number; fill?: string; }; edit: { border?: string; borderWidth: number; fill?: string; }; hover: { border?: string; borderWidth: number; fill?: string; }; tag: { border?: string; borderWidth: number; fill?: string; text?: string; }; } = ...

_drawMetadata.color.active

{ border?: string; borderWidth: number; fill?: string; } = annotationDrawColorSchema

_drawMetadata.color.active.border?

string = ...

_drawMetadata.color.active.borderWidth

number = ...

_drawMetadata.color.active.fill?

string = ...

_drawMetadata.color.default

{ border?: string; borderWidth: number; fill?: string; } = annotationDrawColorSchema

_drawMetadata.color.default.border?

string = ...

_drawMetadata.color.default.borderWidth

number = ...

_drawMetadata.color.default.fill?

string = ...

_drawMetadata.color.edit

{ border?: string; borderWidth: number; fill?: string; } = annotationDrawColorSchema

_drawMetadata.color.edit.border?

string = ...

_drawMetadata.color.edit.borderWidth

number = ...

_drawMetadata.color.edit.fill?

string = ...

_drawMetadata.color.hover

{ border?: string; borderWidth: number; fill?: string; } = annotationDrawColorSchema

_drawMetadata.color.hover.border?

string = ...

_drawMetadata.color.hover.borderWidth

number = ...

_drawMetadata.color.hover.fill?

string = ...

_drawMetadata.color.tag

{ border?: string; borderWidth: number; fill?: string; text?: string; } = tagColorSchema

_drawMetadata.color.tag.border?

string = ...

_drawMetadata.color.tag.borderWidth

number = ...

_drawMetadata.color.tag.fill?

string = ...

_drawMetadata.color.tag.text?

string = ...

_drawMetadata.dimensions?

{ x: number; y1: number; y2: number; } = ...

_drawMetadata.dimensions.x

number = ...

_drawMetadata.dimensions.y1

number = ...

_drawMetadata.dimensions.y2

number = ...

_drawMetadata.draws

object[] = ...

_render

{ isGutter: boolean; lines: object[]; render: string; style: { color: { background?: string; backgroundActive?: string; border?: string; borderActive?: string; color?: string; gutterColor?: string; tagBackground?: string; tagColor?: string; }; renderStyle: any; }; weight?: number; } = renderSchema

_render.isGutter

boolean = ...

_render.lines

object[] = ...

_render.render

string = ...

_render.style

{ color: { background?: string; backgroundActive?: string; border?: string; borderActive?: string; color?: string; gutterColor?: string; tagBackground?: string; tagColor?: string; }; renderStyle: any; } = renderStyleSchema

_render.style.color

{ background?: string; backgroundActive?: string; border?: string; borderActive?: string; color?: string; gutterColor?: string; tagBackground?: string; tagColor?: string; } = annotationColorSchema

_render.style.color.background?

string = ...

_render.style.color.backgroundActive?

string = ...

_render.style.color.border?

string = ...

_render.style.color.borderActive?

string = ...

_render.style.color.color?

string = ...

_render.style.color.gutterColor?

string = ...

_render.style.color.tagBackground?

string = ...

_render.style.color.tagColor?

string = ...

_render.style.renderStyle

any = ...

_render.weight?

number = ...

end

number = ...

id?

string | number = annotationIdSchema

label?

string = ...

start

number = ...

textSelection?

string = ...

Returns

SnapperResult

Overrides

DefaultSnapper.fixOffset

---

getWords()

getWords(): readonly WordPosition[]

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:281

Get the parsed words (useful for debugging/testing)

Returns

readonly WordPosition[]

---

hasWordInRange()

protected hasWordInRange(start, end): boolean

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:268

Check if there's at least one word in the given range.

Parameters

start

number

end

number

Returns

boolean

---

setText()

setText(text, offsetStart): void

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:32

Parameters

text

string

offsetStart

number

Returns

void

Overrides

DefaultSnapper.setText

---

snapEnd()

protected snapEnd(position): number

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:141

Snap end position using halfway rule.

• If in first half of word: snap to previous word end (exclude word)
• If in second half of word: snap to word end (include word)
• If not in a word (whitespace): keep position as-is

Parameters

position

number

Returns

number

---

snapStart()

protected snapStart(position): number

Defined in: libs/core/src/lib/adapter/text/snapper/word-snapper/WordSnapper.ts:115

Snap start position using halfway rule.

• If in first half of word: snap to word start (include word)
• If in second half of word: snap to next word start (exclude word)
• If not in a word: snap to closest word start

Parameters

position

number

Returns

number