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

Interface: AnnotatedTextProps

Defined in: types/props/AnnotatedTextProps.ts:4

Properties

allowCreate?

optional allowCreate: boolean

Defined in: types/props/AnnotatedTextProps.ts:64

Whether to allow creating new annotations

---

allowEdit?

optional allowEdit: boolean

Defined in: types/props/AnnotatedTextProps.ts:60

Whether to allow editing annotations

---

annotationOffset?

optional annotationOffset: number

Defined in: types/props/AnnotatedTextProps.ts:24

Deprecated

---

annotations?

optional annotations: Annotation[]

Defined in: types/props/AnnotatedTextProps.ts:8

List of annotations to be displayed

---

autoAnnotationWeights?

optional autoAnnotationWeights: boolean

Defined in: types/props/AnnotatedTextProps.ts:52

Whether to automatically calculate weights

---

debug?

optional debug: boolean

Defined in: types/props/AnnotatedTextProps.ts:28

Whether verbose debug messages are printed

---

display?

optional display: AnnotationTarget

Defined in: types/props/AnnotatedTextProps.ts:44

Whether to display text or gutter annotations

---

hoveredAnnotations?

optional hoveredAnnotations: string[]

Defined in: types/props/AnnotatedTextProps.ts:16

List of annotation ID's that are hovered. Those will get the "hovered" style class.

---

lines

lines: Line[]

Defined in: types/props/AnnotatedTextProps.ts:20

List of lines

---

render?

optional render: RenderType

Defined in: types/props/AnnotatedTextProps.ts:40

Deprecated

---

selectedAnnotations?

optional selectedAnnotations: string[]

Defined in: types/props/AnnotatedTextProps.ts:12

List of annotation ID's that are selected. Those will get the "active" style class

---

showLabels?

optional showLabels: boolean

Defined in: types/props/AnnotatedTextProps.ts:48

Whether to show the labels

---

style?

optional style: AnnotationStyle

Defined in: types/props/AnnotatedTextProps.ts:56

Object to define classes for styles.

---

theme?

optional theme: string

Defined in: types/props/AnnotatedTextProps.ts:36

only default theme available for now

---

verbose?

optional verbose: boolean

Defined in: types/props/AnnotatedTextProps.ts:32

Whether event messages are printed