Class: TextLineAdapterImpl

About 3 min

@ghentcdh/annotated-text / TextLineAdapterImpl

Class: TextLineAdapterImpl

Defined in: libs/core/src/lib/adapter/text/textline/TextLineAdapter.ts:45

This adapter is used to parse a text that includes line numbers.

f.e. 1.Χ[αι]ρήμ[ων] Ἀπολλωνίωι τῶι\n2.[φι]λτάτωι χαίρειν. will be parsed into an array of TextLine objects of 2 lines, in the gutter the line number will appear.

Constructors

Constructor

new TextLineAdapterImpl(): TextLineAdapterImpl

Properties

annotationAdapter

protected annotationAdapter: AnnotationAdapter<any>

Defined in: libs/core/src/lib/di/BaseAnnotationDiFn.ts:51

annotationModule

protected annotationModule: AnnotationModule

Defined in: libs/core/src/lib/di/BaseAnnotationDiFn.ts:27

flatText

flatText: boolean = false

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:37

limit

limit: object = null

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:38

end

end: number

The end position in the text up to which to consider lines. This is exclusive.

ignoreLines?

optional ignoreLines: boolean

If true, characters that are outside the range will be ignored. If false, lines that intersect with the range will be included. Defaults to false.

start

start: number

The start position in the text from which to consider lines. This is inclusive.

lines

lines: TextLine[] = []

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:43

name

name: string = 'TextLineAdapter'

Defined in: libs/core/src/lib/adapter/text/textline/TextLineAdapter.ts:46

Name of the adapter. Be unique 😃.

style

style: object

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:40

svgModel

protected svgModel: SvgModel

Defined in: libs/core/src/lib/di/BaseAnnotationDiFn.ts:52

textAdapter

protected textAdapter: TextAdapter

Defined in: libs/core/src/lib/di/BaseAnnotationDiFn.ts:50

textDirection

textDirection: TextDirection = 'ltr'

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:36

textLength

textLength: number = 0

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:41

textOffset

textOffset: number = 0

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:39

Methods

changeConfig()

changeConfig(): void

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

clear()

clear(): void

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:110

getLimit()

getLimit(lines?): Pick<{ end: number; ignoreLines?: boolean; start: number; }, "start" | "end">

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:52

Returns

Pick<{ end: number; ignoreLines?: boolean; start: number; }, "start" | "end">

getLine()

getLine(lineUid): TextLine

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:106

inject()

inject<T>(token): T

Defined in: libs/core/src/lib/di/BaseAnnotationDiFn.ts:46

Inject a dependency from the annotation module's container.

Parameters

token

Token<T>

The token identifying the service to inject

parse()

parse(text): TextLine[]

Defined in: libs/core/src/lib/adapter/text/textline/TextLineAdapter.ts:48

Parses the given text into an array of TextLine objects. The parser is also responsible for handling text limits.

setConfig()

setConfig<KEY>(key, value): void

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:83

Change the configuration of the adapter, it will update the eventlistener if rerendering of the annotations is needed. f.e. if the text direction changes, the adapter will emit a change event to update the annotations.

setConfigListener(callback): void

Defined in: libs/core/src/lib/adapter/BaseAdapter.ts:14

Set a listener for configuration changes.

setLineHeight(height): void

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:70

setLines(lines): void

Defined in: libs/core/src/lib/adapter/text/TextAdapter.ts:65

setModule(module): void

Defined in: libs/core/src/lib/di/BaseAnnotationDiFn.ts:33

Set the annotation module for dependency injection. This must be called before using inject().