• Frontend Script API
• <internal>
• Writer

Interface Writer

interface Writer {
addMarker(
name: string,
opts: { range: Range; usingOperation: boolean },
): any;
createElement(
type: string,
opts: Record<string, undefined | null | string>,
): any;
createPositionAt(el: CKNode, opt?: number | "end"): any;
createRange(start: number, end: number): Range;
insertText(
text: string,
opts: undefined | Record<string, unknown> | TextPosition,
position?: TextPosition,
): any;
removeMarker(name: string): any;
setAttribute(name: string, value: string, el: CKNode): any;
setSelection(pos: number, pos?: number): any;
}

Index

Methods

addMarkercreateElementcreatePositionAtcreateRangeinsertTextremoveMarkersetAttributesetSelection

Methods

addMarker

addMarker(name: string, opts: { range: Range; usingOperation: boolean }): any

Parameters

• name: string
• opts: { range: Range; usingOperation: boolean }

Returns any

createElement

createElement(
type: string,
opts: Record<string, undefined | null | string>,
): any

Parameters

• type: string
• opts: Record<string, undefined | null | string>

Returns any

createPositionAt

createPositionAt(el: CKNode, opt?: number | "end"): any

Parameters

• el: CKNode
• Optionalopt: number | "end"

Returns any

createRange

createRange(start: number, end: number): Range

Parameters

• start: number
• end: number

Returns Range

insertText

insertText(
text: string,
opts: undefined | Record<string, unknown> | TextPosition,
position?: TextPosition,
): any

Parameters

• text: string
• opts: undefined | Record<string, unknown> | TextPosition
• Optionalposition: TextPosition

Returns any

removeMarker

removeMarker(name: string): any

Parameters

• name: string

Returns any

setAttribute

setAttribute(name: string, value: string, el: CKNode): any

Parameters

• name: string
• value: string
• el: CKNode

Returns any

setSelection

setSelection(pos: number, pos?: number): any

Parameters

• pos: number
• Optionalpos: number

Returns any

Settings

Member Visibility

• Protected
• Inherited
• External

ThemeOSLightDark

On This Page

Methods addMarkercreateElementcreatePositionAtcreateRangeinsertTextremoveMarkersetAttributesetSelection