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

Class: TextX

Constructors

new TextX()

new TextX(): TextX

Returns

TextX

Properties

Property	Modifier	Type	Default value	Defined in
`id`	`static`	`string`	`'text-x'`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:36
`uri`	`static`	`string`	`'https://github.com/dream-num/univer#text-x'`	packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:38

Methods

delete()

delete(len): this

Parameters

Parameter	Type
`len`	`number`

Returns

this

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:323

empty()

empty(): this

Returns

this

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:334

insert()

insert(len, body): this

Parameters

Parameter	Type
`len`	`number`
`body`	`IDocumentBody`

Returns

this

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:293

push()

push(...args): this

Parameters

Parameter	Type
…`args`	`TextXAction`[]

Returns

this

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:344

retain()

retain(
   len, 
   body?, 
   coverType?): this

Parameters

Parameter	Type
`len`	`number`
`body`?	`IDocumentBody`
`coverType`?	`UpdateDocsAttributeType`

Returns

this

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:304

serialize()

serialize(): TextXAction[]

Returns

TextXAction[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:339

trimEndUselessRetainAction()

protected trimEndUselessRetainAction(): this

Returns

this

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:409

_transform()

static _transform(
   thisActions, 
   otherActions, 
   priority): TextXAction[]

Parameters

Parameter	Type	Default value
`thisActions`	`TextXAction`[]	`undefined`
`otherActions`	`TextXAction`[]	`undefined`
`priority`	`TPriority`	`'right'`

Returns

TextXAction[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:135

apply()

static apply(doc, actions): IDocumentBody

Parameters

Parameter	Type
`doc`	`IDocumentBody`
`actions`	`TextXAction`[]

Returns

IDocumentBody

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:40

compose()

static compose(thisActions, otherActions): TextXAction[]

Parameters

Parameter	Type
`thisActions`	`TextXAction`[]
`otherActions`	`TextXAction`[]

Returns

TextXAction[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:45

invert()

static invert(actions): TextXAction[]

Parameters

Parameter	Type
`actions`	`TextXAction`[]

Returns

TextXAction[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:217

isNoop()

static isNoop(actions): boolean

Parameters

Parameter	Type
`actions`	`TextXAction`[]

Returns

boolean

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:213

makeInvertible()

static makeInvertible(actions, doc): TextXAction[]

Parameters

Parameter	Type
`actions`	`TextXAction`[]
`doc`	`IDocumentBody`

Returns

TextXAction[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:259

transform()

static transform(
   thisActions, 
   otherActions, 
   priority): TextXAction[]

(this↓ \| other→)	insert	retain	delete
insert	Case 1	Case 2	Case 2
retain	Case 1	Case 5	Case 4
delete	Case 1	Case 3	Case 3

Case 1: When the other action type is an insert operation, the insert operation is retained regardless of the type of action this action Case 2: When this action type is an insert operation and the other action type is a non-insert operation, you need to retain the length of this action insert Case 3: When this action is a delete operation, there are two scenarios: 1) When other is a delete operation, since it is a delete operation, this has already been deleted, so the target does not need to be in delete, and it can be continued directly 2) When other is the retain operation, although this action delete occurs first, the delete priority is higher, so the delete operation is retained, and the origin delete has been applied, so it is directly continued Case 4: other is the delete operation, this is the retain operation, and the target delete operation is kept Case 5: When both other and this are retain operations 1) If the other body attribute does not exist, directly retain length 2) If the other body property exists, then execute the TransformBody logic to override it

Parameters

Parameter	Type	Default value
`thisActions`	`TextXAction`[]	`undefined`
`otherActions`	`TextXAction`[]	`undefined`
`priority`	`TPriority`	`'right'`

Returns

TextXAction[]

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:130

transformPosition()

static transformPosition(
   thisActions, 
   index, 
   priority): number

Used to transform selection. Why not named transformSelection? Because Univer Doc supports multiple Selections in one document, user need to encapsulate transformSelections at the application layer.

Parameters

Parameter	Type	Default value
`thisActions`	`TextXAction`[]	`undefined`
`index`	`number`	`undefined`
`priority`	`boolean`	`false`

Returns

number

Defined in

packages/api/tmp/univer-pro/submodules/univer/packages/core/src/docs/data-model/text-x/text-x.ts:191

Styles Themecolor