@ghentcdh/vue-component-annotated-text / DefaultConfig

Variable: DefaultConfig

const DefaultConfig: object

Defined in: compute/model/annotation.config.ts:14

Type declaration

actions

readonly actions: object

actions.create

readonly create: false = false

actions.edit

readonly edit: false = false

gutter

readonly gutter: object

gutter.gap

readonly gap: 6 = 6

gutter.width

readonly width: 3 = 3

hover

readonly hover: object

hover.color

readonly color: object

hover.color.border

readonly border: "rgba(100, 100, 100, 0.5)" = "rgba(100, 100, 100, 0.5)"

hover.color.fill

readonly fill: "rgba(1, 1, 1, 0.1)" = "rgba(1, 1, 1, 0.1)"

onError()

readonly onError: (error, message, ...params) => void

Parameters

error

"INVALID_ANNOTATION" | "INVALID_LINE"

message

string

params

...any[]

Returns

void

onEvent()

readonly onEvent: <T>(event) => void

Type Parameters

T

T extends AnnotationEventData

Parameters

event

AnnotationEvent<T>

Returns

void

text

readonly text: object

text.border

readonly border: 2 = 2

text.borderRadius

readonly borderRadius: 3 = 3

text.handleRadius

readonly handleRadius: 6 = 6

text.lineHeight

readonly lineHeight: 22 = 22

text.padding

readonly padding: 3 = 3

text.rtl

readonly rtl: false = false

Support for right-to-left text.

visualEvent

readonly visualEvent: object

visualEvent.create()

readonly create: () => object

Create a new annotation object with default values.

Returns

object

color

color: AnnotationColor

id

id: string

isGutter

isGutter: boolean = false

visualEvent.hover()

readonly hover: (annotation) => boolean

If return true, then on hover it becomes the active color

Parameters

annotation

Annotation

Returns

boolean

visualEvent.useSnapper()

readonly useSnapper: (action, annotation) => object

Use a word snapper function to adjust the start and end indices of an annotation.

Parameters

action

SnapperAction

annotation

Annotation

Returns

object

end

end: number = annotation.end

start

start: number = annotation.start