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

Class: ReadCursor

Extends

Cursor

Constructors

new ReadCursor()

new ReadCursor(op?): ReadCursor

Parameters

Parameter	Type
`op`?	`JSONOp`

Returns

ReadCursor

Inherited from

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:10

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

Methods

[iterator]()

iterator: Generator<Key, void, unknown>

Returns

Generator<Key, void, unknown>

Defined in

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

ascend()

ascend(): void

Returns

void

Inherited from

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:11

clone()

clone(): ReadCursor

Returns

ReadCursor

Defined in

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

descendFirst()

descendFirst(): boolean

Returns

boolean

Defined in

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

eachDrop()

eachDrop<W>(w, fn): void

Type Parameters

Type Parameter
`W` extends `null` \| `WriteCursor`

Parameters

Parameter	Type
`w`	`W`
`fn`	(`slot`, `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:25

eachPick()

eachPick<W>(w, fn): void

Type Parameters

Type Parameter
`W` extends `null` \| `WriteCursor`

Parameters

Parameter	Type
`w`	`W`
`fn`	(`slot`, `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:24

get()

get(): null | (string | number | JSONOpList | JSONOpComponent)[]

Returns

null | (string | number | JSONOpList | JSONOpComponent)[]

Defined in

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

getComponent()

getComponent(): null | JSONOpComponent

Returns

null | JSONOpComponent

Defined in

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

getKey()

getKey(): Key

Returns

Key

Defined in

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

getPath()

getPath(): Path

Returns

Path

Inherited from

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:12

nextSibling()

nextSibling(): boolean

Returns

boolean

Defined in

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

traverse()

traverse<W>(w, fn): void

Type Parameters

Type Parameter
`W` extends `null` \| `WriteCursor`

Parameters

Parameter	Type
`w`	`W`
`fn`	(`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:23

Readme Writecursor