Editor

Class: Editor

Defined in: editor.svelte.ts:193

Extends

• EventDispatcher<{ change: [string]; }>

Constructors

Constructor

new Editor(data?, extensions?): Editor

Defined in: editor.svelte.ts:201

Parameters

data?

string = ""

extensions?

Extension[] = []

Returns

Editor

Overrides

EventDispatcher.constructor

Properties

data

data: string = ""

Defined in: editor.svelte.ts:202

---

extensions

extensions: Extension[] = []

Defined in: editor.svelte.ts:203

---

file

file: TFile | null

Defined in: editor.svelte.ts:197

---

id

readonly id: `${string}-${string}-${string}-${string}-${string}`

Defined in: editor.svelte.ts:198

---

save

readonly save: DebouncedFunc<() => Promise<void>>

Defined in: editor.svelte.ts:209

---

view

view: EditorView

Defined in: editor.svelte.ts:196

Accessors

cm

Get Signature

get cm(): EditorView

Defined in: editor.svelte.ts:216

Returns

EditorView

Methods

blur()

blur(): void

Defined in: editor.svelte.ts:429

Returns

void

---

destroy()

destroy(): void

Defined in: editor.svelte.ts:232

Returns

void

---

dispatch()

dispatch<T>(eventName, …args): boolean

Defined in: events.ts:105

Type Parameters

T

T extends "change"

Parameters

eventName

T

args

…ArgumentMap<{ change: [string]; }>[Extract<T, "change">]

Returns

boolean

Inherited from

EventDispatcher.dispatch

---

emit()

emit<T>(eventName, …args): boolean

Defined in: events.ts:98

Type Parameters

T

T extends "change"

Parameters

eventName

T

args

…ArgumentMap<{ change: [string]; }>[Extract<T, "change">]

Returns

boolean

Inherited from

EventDispatcher.emit

---

exec()

exec(command): void

Defined in: editor.svelte.ts:472

Parameters

command

EditorCommandName

Returns

void

---

focus()

focus(): void

Defined in: editor.svelte.ts:425

Returns

void

---

getCursor()

getCursor(side?): EditorPosition

Defined in: editor.svelte.ts:361

Parameters

side?

"anchor" | "from" | "to" | "head"

Returns

EditorPosition

---

getDoc()

getDoc(): this

Defined in: editor.svelte.ts:613

Returns

this

---

getLine()

getLine(line): string

Defined in: editor.svelte.ts:339

Parameters

line

number

Returns

string

---

getRange()

getRange(from, to): string

Defined in: editor.svelte.ts:347

Parameters

from

EditorPosition

to

EditorPosition

Returns

string

---

getScrollInfo()

getScrollInfo(): EditorScrollInfo

Defined in: editor.svelte.ts:437

Returns

EditorScrollInfo

---

getSelection()

getSelection(): string

Defined in: editor.svelte.ts:605

Returns

string

---

getValue()

getValue(): string

Defined in: editor.svelte.ts:224

Returns

string

---

hasFocus()

hasFocus(): boolean

Defined in: editor.svelte.ts:433

Returns

boolean

---

lastLine()

lastLine(): number

Defined in: editor.svelte.ts:588

Returns

number

---

lineCount()

lineCount(): number

Defined in: editor.svelte.ts:601

Returns

number

---

listSelections()

listSelections(): EditorSelection[]

Defined in: editor.svelte.ts:374

Returns

EditorSelection[]

---

off()

off<T>(eventName, listener, context?, once?): void

Defined in: events.ts:78

Type Parameters

T

T extends "change"

Parameters

eventName

T

listener

(…args) => void

context?

any

once?

boolean

Returns

void

Inherited from

EventDispatcher.off

---

offref()

offref<T>(ref): void

Defined in: events.ts:87

Type Parameters

T

T extends "change"

Parameters

ref

EventRef<{ change: [string]; }, T>

Returns

void

Inherited from

EventDispatcher.offref

---

offsetToPos()

offsetToPos(offset): EditorPosition

Defined in: editor.svelte.ts:560

Parameters

offset

number

Returns

EditorPosition

---

on()

on<T>(eventName, listener, context?): EventRef<{ change: [string]; }, T, any>

Defined in: events.ts:48

Type Parameters

T

T extends "change"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ change: [string]; }, T, any>

Inherited from

EventDispatcher.on

---

once()

once<T>(eventName, listener, context?): EventRef<{ change: [string]; }, T, any>

Defined in: events.ts:63

Type Parameters

T

T extends "change"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ change: [string]; }, T, any>

Inherited from

EventDispatcher.once

---

onChange()

onChange(data): void

Defined in: editor.svelte.ts:220

Parameters

data

string

Returns

void

---

posToOffset()

posToOffset(pos): number

Defined in: editor.svelte.ts:556

Parameters

pos

EditorPosition

Returns

number

---

processLines()

processLines<T>(read, write, ignoreEmpty?): void

Defined in: editor.svelte.ts:564

Type Parameters

T

T

Parameters

read

(line, lineText) => T | null

write

(line, lineText, value) => void | EditorChange

ignoreEmpty?

boolean

Returns

void

---

redo()

redo(): void

Defined in: editor.svelte.ts:468

Returns

void

---

refresh()

refresh(): void

Defined in: editor.svelte.ts:228

Returns

void

---

replaceContent()

replaceContent(content, options?): void

Defined in: editor.svelte.ts:325

Parameters

content

string

options?

userEvent?

string

Returns

void

---

replaceRange()

replaceRange(replacement, from, to?, origin?): void

Defined in: editor.svelte.ts:409

Parameters

replacement

string

from

EditorPosition

to?

EditorPosition

origin?

string

Returns

void

---

replaceSelection()

replaceSelection(replacement, origin?): void

Defined in: editor.svelte.ts:354

Parameters

replacement

string

origin?

string

Returns

void

---

scrollIntoView()

scrollIntoView(range, center?): void

Defined in: editor.svelte.ts:456

Parameters

range

EditorRange

center?

boolean

Returns

void

---

scrollTo()

scrollTo(x?, y?): void

Defined in: editor.svelte.ts:449

Parameters

x?

number | null

y?

number | null

Returns

void

---

setCursor()

setCursor(pos, ch?): void

Defined in: editor.svelte.ts:381

Parameters

pos

number | EditorPosition

ch?

number

Returns

void

---

setLine()

setLine(n, text): void

Defined in: editor.svelte.ts:592

Parameters

n

number

text

string

Returns

void

---

setSelection()

setSelection(anchor, head?): void

Defined in: editor.svelte.ts:386

Parameters

anchor

EditorPosition

head?

EditorPosition

Returns

void

---

setSelections()

setSelections(ranges, main?): void

Defined in: editor.svelte.ts:396

Parameters

ranges

EditorSelectionOrCaret[]

main?

number = 0

Returns

void

---

setValue()

setValue(content): void

Defined in: editor.svelte.ts:309

Parameters

content

string

Returns

void

---

somethingSelected()

somethingSelected(): boolean

Defined in: editor.svelte.ts:343

Returns

boolean

---

trackChanges()

trackChanges(callback?): () => void

Defined in: editor.svelte.ts:242

Parameters

callback?

(data, editor) => void

Returns

() => void

---

transaction()

transaction(tx, origin?): void

Defined in: editor.svelte.ts:496

Parameters

tx

EditorTransaction

origin?

string

Returns

void

---

trigger()

trigger<T>(eventName, …args): boolean

Defined in: events.ts:91

Type Parameters

T

T extends "change"

Parameters

eventName

T

args

…ArgumentMap<{ change: [string]; }>[Extract<T, "change">]

Returns

boolean

Inherited from

EventDispatcher.trigger

---

tryTrigger()

tryTrigger<T>(evt, …args): void

Defined in: events.ts:112

Type Parameters

T

T extends "change"

Parameters

evt

EventRef<{ change: [string]; }, T>

args

…ArgumentMap<{ change: [string]; }>[Extract<T, "change">]

Returns

void

Inherited from

EventDispatcher.tryTrigger

---

undo()

undo(): void

Defined in: editor.svelte.ts:464

Returns

void

---

updateExtensions()

updateExtensions(extensions, context?): this

Defined in: editor.svelte.ts:279

Parameters

extensions

Extension[]

context?

Record<string, any>

Returns

this

---

wordAt()

wordAt(pos): EditorRange | null

Defined in: editor.svelte.ts:540

Parameters

pos

EditorPosition

Returns

EditorRange | null