@univerjs/core v0.5.0-beta.1 • Docs

Class: WriteCursor

Extends

Cursor

Constructors

new WriteCursor()

new WriteCursor(op?): WriteCursor

Parameters

Parameter	Type
`op`?	`JSONOp`

Returns

WriteCursor

Overrides

Cursor.constructor

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:30

Properties

Property	Type	Inherited from	Defined in
`container`	`JSONOp`	`Cursor.container`	packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:8
`idx`	`number`	`Cursor.idx`	packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:9
`indexes`	`number`[]	`Cursor.indexes`	packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:6
`lcIdx`	`number`	`Cursor.lcIdx`	packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:7
`parents`	`JSONOp`[]	`Cursor.parents`	packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:5
`pendingDescent`	`Path`	-	packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:28

Methods

ascend()

ascend(): void

Returns

void

Overrides

Cursor.ascend

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:38

at()

at(path, fn): this

Parameters

Parameter	Type
`path`	`Path`
`fn`	(`w`) => `void`

Returns

this

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:40

descend()

descend(key): void

Parameters

Parameter	Type
`key`	`Key`

Returns

void

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:36

descendPath()

descendPath(path): this

Parameters

Parameter	Type
`path`	`Path`

Returns

this

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:37

get()

get(): JSONOp

Returns

JSONOp

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:35

getComponent()

getComponent(): JSONOpComponent

Returns

JSONOpComponent

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:33

getPath()

getPath(): Path

Returns

Path

Overrides

Cursor.getPath

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:43

mergeTree()

mergeTree(data, mergeFn?): void

Parameters

Parameter	Type
`data`	`JSONOp`
`mergeFn`?	(`c`, `w`) => `void`

Returns

void

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:39

reset()

reset(): void

Returns

void

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:32

write()

write<K>(key, value): void

Type Parameters

Type Parameter
`K` extends keyof `JSONOpComponent`

Parameters

Parameter	Type
`key`	`K`
`value`	`JSONOpComponent`[`K`]

Returns

void

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:34

writeAtPath()

writeAtPath<K>(
   path, 
   key, 
   value): this

Type Parameters

Type Parameter
`K` extends keyof `JSONOpComponent`

Parameters

Parameter	Type
`path`	`Path`
`key`	`K`
`value`	`JSONOpComponent`[`K`]

Returns

this

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:41

writeMove()

writeMove(
   path1, 
   path2, 
   slot?): this

Parameters

Parameter	Type
`path1`	`Path`
`path2`	`Path`
`slot`?	`number`

Returns

this

Defined in

packages/api/tmp/univer-pro/node_modules/.pnpm/ot-json1@1.0.2/node_modules/ot-json1/dist/cursor.d.ts:42

Readcursor Conflicttype