Skip to content

BlockSuite API Documentation / @blocksuite/store / Y / XmlText

Class: XmlText ​

Represents text in a Dom Element. In the future this type will also handle simple formatting information like bold and italic.

Contents ​

Extends ​

Constructors ​

new XmlText(string) ​

new XmlText(string?): XmlText

Parameters ​

• string?: string

The initial value of the YText.

Returns ​

XmlText

Inherited from ​

@blocksuite/store.Y.Text.constructor

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:97

Properties ​

_dEH ​

_dEH: EventHandler<YEvent<any>[], Transaction>

Deep event handlers

Inherited from ​

@blocksuite/store.Y.Text._dEH

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:46


_eH ​

_eH: EventHandler<YTextEvent, Transaction>

Event handlers

Inherited from ​

@blocksuite/store.Y.Text._eH

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:41


_hasFormatting ​

_hasFormatting: boolean

Whether this YText contains formatting attributes. This flag is updated when a formatting item is integrated (see ContentFormat.integrate)

Inherited from ​

@blocksuite/store.Y.Text._hasFormatting

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:107


_item ​

_item: null | Item

Inherited from ​

@blocksuite/store.Y.Text._item

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:23


_length ​

_length: number

Inherited from ​

@blocksuite/store.Y.Text._length

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:36


_map ​

_map: Map<string, Item>

Inherited from ​

@blocksuite/store.Y.Text._map

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:27


_pending ​

_pending: null | () => void[]

Array of pending operations on this type

Inherited from ​

@blocksuite/store.Y.Text._pending

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:102


_searchMarker ​

_searchMarker: null | ArraySearchMarker[]

Inherited from ​

@blocksuite/store.Y.Text._searchMarker

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:50


_start ​

_start: null | Item

Inherited from ​

@blocksuite/store.Y.Text._start

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:31


doc ​

doc: null | Doc

Inherited from ​

@blocksuite/store.Y.Text.doc

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:35

Accessors ​

_first ​

get _first(): null | Item

The first non-deleted item

Returns ​

null | Item

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:81


length ​

get length(): number

Number of characters of this text type.

Returns ​

number

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:113


nextSibling ​

get nextSibling(): null | XmlText | XmlElement<Object>

Returns ​

null | XmlText | XmlElement<Object>

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YXmlText.d.ts:9


parent ​

get parent(): null | AbstractType<any>

Returns ​

null | AbstractType<any>

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:54


prevSibling ​

get prevSibling(): null | XmlText | XmlElement<Object>

Returns ​

null | XmlText | XmlElement<Object>

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YXmlText.d.ts:15

Methods ​

_callObserver() ​

_callObserver(transaction, _parentSubs): void

Creates YEvent and calls all type observers. Must be implemented by each type.

Parameters ​

• transaction: Transaction

• _parentSubs: Set<null | string>

Keys changed on this type. null if list was modified.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text._callObserver

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:89


_copy() ​

_copy(): XmlText

Returns ​

XmlText

Overrides ​

@blocksuite/store.Y.Text._copy

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YXmlText.d.ts:18


_integrate() ​

_integrate(y, item): void

Integrate this type into the Yjs instance.

  • Save this struct in the os
  • This type is sent to other client
  • Observer functions are fired

Parameters ​

• y: Doc

The Yjs instance

• item: Item

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text._integrate

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:118


_write() ​

_write(_encoder): void

Parameters ​

• _encoder: UpdateEncoderV1 | UpdateEncoderV2

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text._write

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:77


applyDelta() ​

applyDelta(delta, opts?): void

Apply a Delta on this shared YText type.

Parameters ​

• delta: any

The changes to apply on this element.

• opts?: Object

• opts.sanitize?: boolean

Sanitize input delta. Removes ending newlines if set to true.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.applyDelta

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:141


clone() ​

clone(): XmlText

Returns ​

XmlText

Overrides ​

@blocksuite/store.Y.Text.clone

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YXmlText.d.ts:22


delete() ​

delete(index, length): void

Deletes text starting from an index.

Parameters ​

• index: number

Index at which to start deleting.

• length: number

The number of characters to remove. Defaults to 1.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.delete

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:185


format() ​

format(index, length, attributes): void

Assigns properties to a range of text.

Parameters ​

• index: number

The position where to start formatting.

• length: number

The amount of characters to assign properties to.

• attributes: Object

Attribute information to apply on the text.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.format

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:196


getAttribute() ​

getAttribute(attributeName): any

Returns an attribute value that belongs to the attribute name.

Parameters ​

• attributeName: string

The attribute name that identifies the queried value.

Returns ​

any

The queried attribute value.

Inherited from ​

@blocksuite/store.Y.Text.getAttribute

Note ​

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:229


getAttributes() ​

getAttributes(): Object

Returns all attribute name/value pairs in a JSON Object.

Returns ​

Object

A JSON Object that describes the attributes.

Inherited from ​

@blocksuite/store.Y.Text.getAttributes

Note ​

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:239


insert() ​

insert(index, text, attributes?): void

Insert text at a given index.

Parameters ​

• index: number

The index at which to start inserting.

• text: string

The text to insert at the specified position.

• attributes?: Object

Optionally define some formatting information to apply on the inserted Text.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.insert

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:165


insertEmbed() ​

insertEmbed(index, embed, attributes?): void

Inserts an embed at a index.

Parameters ​

• index: number

The index to insert the embed at.

• embed: Object | AbstractType<any>

The Object that represents the embed.

• attributes?: Object

Attribute information to apply on the embed

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.insertEmbed

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:176


observe() ​

observe(f): void

Observe all events that are created on this type.

Parameters ​

• f: (arg0, arg1) => void

Observer function

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.observe

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:95


observeDeep() ​

observeDeep(f): void

Observe all events that are created by this type and its children.

Parameters ​

• f: (arg0, arg1) => void

Observer function

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.observeDeep

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:101


removeAttribute() ​

removeAttribute(attributeName): void

Removes an attribute.

Parameters ​

• attributeName: string

The attribute name that is to be removed.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.removeAttribute

Note ​

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:206


setAttribute() ​

setAttribute(attributeName, attributeValue): void

Sets or updates an attribute.

Parameters ​

• attributeName: string

The attribute name that is to be set.

• attributeValue: any

The attribute value that is to be set.

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.setAttribute

Note ​

Xml-Text nodes don't have attributes. You can use this feature to assign properties to complete text-blocks.

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:217


toDOM() ​

toDOM(_document?, hooks?, binding?): Text

Creates a Dom Element that mirrors this YXmlText.

Parameters ​

• _document?: Document

The document object (you must define this when calling this method in nodejs)

• hooks?: Object

Optional property to customize how hooks are presented in the DOM

• binding?: any

You should not set this property. This is used if DomBinding wants to create a association to the created DOM type.

Returns ​

Text

The Element

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YXmlText.d.ts:38


toDelta() ​

toDelta(snapshot?, prevSnapshot?, computeYChange?): any

Returns the Delta representation of this YText type.

Parameters ​

• snapshot?: Snapshot

• prevSnapshot?: Snapshot

• computeYChange?: (arg0, arg1) => any

Returns ​

any

The Delta representation of this type.

Inherited from ​

@blocksuite/store.Y.Text.toDelta

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:154


toJSON() ​

toJSON(): string

Returns the unformatted string representation of this YText type.

Returns ​

string

Inherited from ​

@blocksuite/store.Y.Text.toJSON

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YText.d.ts:130


toString() ​

toString(): any

Returns ​

any

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/YXmlText.d.ts:41


unobserve() ​

unobserve(f): void

Unregister an observer function.

Parameters ​

• f: (arg0, arg1) => void

Observer function

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.unobserve

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:107


unobserveDeep() ​

unobserveDeep(f): void

Unregister an observer function.

Parameters ​

• f: (arg0, arg1) => void

Observer function

Returns ​

void

Inherited from ​

@blocksuite/store.Y.Text.unobserveDeep

Source ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/types/AbstractType.d.ts:113


Generated using typedoc-plugin-markdown and TypeDoc