decorations

Documentation / editor/modules/decorations

DecorateEvent

Defined in: editor/modules/decorations.ts:43

Extends

• Event

Constructors

Constructor

new DecorateEvent(type: string, init: DecorateEventInit): DecorateEvent;

Defined in: editor/modules/decorations.ts:49

Parameters

Parameter	Type
type	string
init	DecorateEventInit

Returns

DecorateEvent

Overrides

Event.constructor

Properties

change?

optional change: default;

Defined in: editor/modules/decorations.ts:46

changedLines?

optional changedLines: Line[];

Defined in: editor/modules/decorations.ts:47

doc

doc: default;

Defined in: editor/modules/decorations.ts:45

old

old: default;

Defined in: editor/modules/decorations.ts:44

---

Decorator

Defined in: editor/modules/decorations.ts:199

Constructors

Constructor

new Decorator(
   name: string, 
   doc: default, 
   decoration: default, 
   apply: (name: string, updates: default) => void, 
   remove: (name: string) => void): Decorator;

Defined in: editor/modules/decorations.ts:207

Parameters

Parameter	Type
name	string
doc	default
decoration	default
apply	(name: string, updates: default) => void
remove	(name: string) => void

Returns

Decorator

Properties

change

change: default;

Defined in: editor/modules/decorations.ts:200

Methods

apply()

apply(): void;

Defined in: editor/modules/decorations.ts:230

Returns

void

clear()

clear(range?: EditorRange): Decorator;

Defined in: editor/modules/decorations.ts:238

Parameters

Parameter	Type
range?	EditorRange

Returns

Decorator

clearLine()

clearLine(value: string | number | Line): Decorator;

Defined in: editor/modules/decorations.ts:272

Parameters

Parameter	Type
value	string | number | Line

Returns

Decorator

clearLines()

clearLines(lines: Line[]): Decorator;

Defined in: editor/modules/decorations.ts:248

Parameters

Parameter	Type
lines	Line[]

Returns

Decorator

decorateLine()

decorateLine(range: number | EditorRange, decoration: Decorations): Decorator;

Defined in: editor/modules/decorations.ts:293

Parameters

Parameter	Type
range	number | EditorRange
decoration	Decorations

Returns

Decorator

decorateText()

decorateText(range: EditorRange, decoration: Decorations): Decorator;

Defined in: editor/modules/decorations.ts:288

Parameters

Parameter	Type
range	EditorRange
decoration	Decorations

Returns

Decorator

getDecoration()

getDecoration(): default;

Defined in: editor/modules/decorations.ts:226

Returns

default

hasDecorations()

hasDecorations(): boolean;

Defined in: editor/modules/decorations.ts:222

Returns

boolean

insertDecoration()

insertDecoration(at: number, decoration: Decorations): Decorator;

Defined in: editor/modules/decorations.ts:298

Parameters

Parameter	Type
at	number
decoration	Decorations

Returns

Decorator

invert()

invert(range?: EditorRange): default;

Defined in: editor/modules/decorations.ts:283

Parameters

Parameter	Type
range?	EditorRange

Returns

default

remove()

remove(): void;

Defined in: editor/modules/decorations.ts:234

Returns

void

---

DecorateEventInit

Defined in: editor/modules/decorations.ts:36

Extends

• EventInit

Properties

Property	Type	Defined in
change?	default	editor/modules/decorations.ts:39
changedLines?	Line[]	editor/modules/decorations.ts:40
doc	default	editor/modules/decorations.ts:38
old	default	editor/modules/decorations.ts:37

---

Decorations

Defined in: editor/modules/decorations.ts:30

Indexable

[attributeName: string]: any

Properties

Property	Type	Defined in
class?	string	editor/modules/decorations.ts:31
style?	string	editor/modules/decorations.ts:32

---

DecorationsModule

Defined in: editor/modules/decorations.ts:58

Properties

Property	Modifier	Type	Defined in
clearDecorations	public	() => void	editor/modules/decorations.ts:63
doc	readonly	default	editor/modules/decorations.ts:60
gatherDecorations	public	(change?: default, changedLines?: Line[]) => void	editor/modules/decorations.ts:64
getDecorator	public	(name: string) => Decorator	editor/modules/decorations.ts:61
old	readonly	default	editor/modules/decorations.ts:59
removeDecorations	public	(name: string) => boolean	editor/modules/decorations.ts:62

Methods

destroy()

destroy(): void;

Defined in: editor/modules/decorations.ts:66

Returns

void

init()

init(): void;

Defined in: editor/modules/decorations.ts:65

Returns

void

---

applyDecorations()

function applyDecorations(
   vnode: VNode, 
   attributes: AttributeMap, 
   defaultClasses?: string[]): VNode;

Defined in: editor/modules/decorations.ts:307

Parameters

Parameter	Type
vnode	VNode
attributes	AttributeMap
defaultClasses?	string[]

Returns

VNode

---

decorations()

function decorations(editor: Editor): DecorationsModule;

Defined in: editor/modules/decorations.ts:69

Parameters

Parameter	Type
editor	Editor

Returns

DecorationsModule