API > @blocksuite/store > Y > XmlFragment

Class: XmlFragment

Represents a list of YXmlElement.and YXmlText types. A YxmlFragment is similar to a YXmlElement, but it does not have a nodeName and it does not have attributes. Though it can be bound to a DOM element - in this case the attributes and the nodeName are not shared.

Extends

AbstractType< YXmlEvent >

Constructors

constructor

new XmlFragment(): XmlFragment

Returns

XmlFragment

Overrides

AbstractType.constructor

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:64

Properties

_dEH

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

Deep event handlers

Defined In

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

Inherited from

AbstractType._dEH

_eH

_eH: EventHandler< YXmlEvent, Transaction >

Event handlers

Defined In

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

Inherited from

AbstractType._eH

_item

_item: null | Item

Defined In

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

Inherited from

AbstractType._item

_length

_length: number

Defined In

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

Inherited from

AbstractType._length

_map

_map: Map< string, Item >

Defined In

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

Inherited from

AbstractType._map

_prelimContent

_prelimContent: null | any[]

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:68

_searchMarker

_searchMarker: null | ArraySearchMarker[]

Defined In

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

Inherited from

AbstractType._searchMarker

_start

_start: null | Item

Defined In

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

Inherited from

AbstractType._start

doc

doc: null | Doc

Defined In

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

Inherited from

AbstractType.doc

Accessors

_first

get _first(): null | Item

Defined In

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

Inherited from

AbstractType._first

firstChild

get firstChild(): null | XmlText | XmlElement< {} >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:72

length

get length(): number

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:91

parent

get parent(): null | AbstractType< any >

Defined In

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

Inherited from

AbstractType.parent

Methods

_callObserver

_callObserver(transaction, _parentSubs): void

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

Parameters

Parameter	Type	Description
`transaction`	`Transaction`	-
`_parentSubs`	`Set`< `null` \| `string` >	Keys changed on this type. `null` if list was modified.

Returns

void

Inherited from

AbstractType._callObserver

Defined In

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

_copy

_copy(): XmlFragment

Returns

XmlFragment

Overrides

AbstractType._copy

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:86

_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

Parameter	Type	Description
`y`	`Doc`	The Yjs instance
`item`	`Item`	-

Returns

void

Overrides

AbstractType._integrate

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:85

_write

_write(_encoder): void

Parameters

Parameter	Type
`_encoder`	`UpdateEncoderV1` \| `UpdateEncoderV2`

Returns

void

Inherited from

AbstractType._write

Defined In

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

clone

clone(): XmlFragment

Returns

XmlFragment

Overrides

AbstractType.clone

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:90

createTreeWalker

createTreeWalker(filter): YXmlTreeWalker

Create a subtree of childNodes.

Parameters

Parameter	Type	Description
`filter`	`function`	Function that is called on each child element and returns a Boolean indicating whether the child is to be included in the subtree.

Returns

YXmlTreeWalker

A subtree and a position within it.

Example

const walker = elem.createTreeWalker(dom => dom.nodeName === 'div')
for (let node in walker) {
  // `node` is a div node
  nop(node)
}

const walker = elem.createTreeWalker(dom => dom.nodeName === 'div')
for (let node in walker) {
  // `node` is a div node
  nop(node)
}

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:109

delete

delete(index, length?): void

Deletes elements starting from an index.

Parameters

Parameter	Type	Description
`index`	`number`	Index at which to start deleting elements
`length`?	`number`	The number of elements to remove. Defaults to 1.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:188

forEach

forEach(f): void

Executes a provided function on once on overy child element.

Parameters

Parameter	Type	Description
`f`	`function`	A function to execute on every element of this YArray.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:227

get

get(index): XmlText | XmlElement< {} >

Returns the i-th element from a YArray.

Parameters

Parameter	Type	Description
`index`	`number`	The index of the element to return from the YArray

Returns

XmlText | XmlElement< {} >

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:213

insert

insert(index, content): void

Inserts new content at an index.

Parameters

Parameter	Type	Description
`index`	`number`	The index to insert content at
`content`	(`XmlText` \| `XmlElement`< {} >)[]	The array of content

Returns

void

Example

// Insert character 'a' at position 0
 xml.insert(0, [new Y.XmlText('text')])

// Insert character 'a' at position 0
 xml.insert(0, [new Y.XmlText('text')])

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:170

insertAfter

insertAfter(ref, content): void

Inserts new content at an index.

Parameters

Parameter	Type	Description
`ref`	`null` \| `Item` \| `XmlText` \| `XmlElement`< {} >	The index to insert content at
`content`	(`XmlText` \| `XmlElement`< {} >)[]	The array of content

Returns

void

Example

// Insert character 'a' at position 0
 xml.insert(0, [new Y.XmlText('text')])

// Insert character 'a' at position 0
 xml.insert(0, [new Y.XmlText('text')])

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:181

observe

observe(f): void

Observe all events that are created on this type.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.observe

Defined In

node_modules/.pnpm/yjs@13.6.8/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

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.observeDeep

Defined In

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

push

push(content): void

Appends content to this YArray.

Parameters

Parameter	Type	Description
`content`	(`XmlText` \| `XmlElement`< {} >)[]	Array of content to append.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:200

querySelector

querySelector(query): null | XmlText | XmlHook | XmlElement< {} >

Returns the first YXmlElement that matches the query. Similar to DOM's querySelector.

Query support:

tagname TODO:
id
attribute

Parameters

Parameter	Type	Description
`query`	`string`	The query on the children.

Returns

null | XmlText | XmlHook | XmlElement< {} >

The first element that matches the query or null.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:125

querySelectorAll

querySelectorAll(query): (null | XmlText | XmlHook | XmlElement< {} >)[]

Returns all YXmlElements that match the query. Similar to Dom's querySelectorAll.

Parameters

Parameter	Type	Description
`query`	`string`	The query on the children

Returns

(null | XmlText | XmlHook | XmlElement< {} >)[]

The elements that match this query.

Todo

Does not yet support all queries. Currently only query by tagName.

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:137

slice

slice(start?, end?): (XmlText | XmlElement< {} >)[]

Transforms this YArray to a JavaScript Array.

Parameters

Parameter	Type
`start`?	`number`
`end`?	`number`

Returns

(XmlText | XmlElement< {} >)[]

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:221

toArray

toArray(): (XmlText | XmlHook | XmlElement< {} >)[]

Transforms this YArray to a JavaScript Array.

Returns

(XmlText | XmlHook | XmlElement< {} >)[]

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:194

toDOM

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

Creates a Dom Element that mirrors this YXmlElement.

Parameters

Parameter	Type	Description
`_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

Node

The Element

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:157

toJSON

toJSON(): string

Returns

string

Overrides

AbstractType.toJSON

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:141

unobserve

unobserve(f): void

Unregister an observer function.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.unobserve

Defined In

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

unobserveDeep

unobserveDeep(f): void

Unregister an observer function.

Parameters

Parameter	Type	Description
`f`	`function`	Observer function

Returns

void

Inherited from

AbstractType.unobserveDeep

Defined In

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

unshift

unshift(content): void

Preppends content to this YArray.

Parameters

Parameter	Type	Description
`content`	(`XmlText` \| `XmlElement`< {} >)[]	Array of content to preppend.

Returns

void

Defined In

node_modules/.pnpm/yjs@13.6.8/node_modules/yjs/dist/src/types/YXmlFragment.d.ts:206

Class: XmlFragment ​

Extends ​

Constructors ​

constructor ​

Returns ​

Overrides ​

Defined In ​

Properties ​

_dEH ​

Defined In ​

Inherited from ​

_eH ​

Defined In ​

Inherited from ​

_item ​

Defined In ​

Inherited from ​

_length ​

Defined In ​

Inherited from ​

_map ​

Defined In ​

Inherited from ​

_prelimContent ​

Defined In ​

_searchMarker ​

Defined In ​

Inherited from ​

_start ​

Defined In ​

Inherited from ​

doc ​

Defined In ​

Inherited from ​

Accessors ​

_first ​

Defined In ​

Inherited from ​

firstChild ​

Defined In ​

length ​

Defined In ​

parent ​

Defined In ​

Inherited from ​

Methods ​

_callObserver ​

Parameters ​

Returns ​

Inherited from ​

Defined In ​

_copy ​

Returns ​

Overrides ​

Defined In ​

_integrate ​

Parameters ​

Returns ​

Overrides ​

Defined In ​

_write ​

Parameters ​

Returns ​

Inherited from ​

Defined In ​

clone ​

Returns ​

Overrides ​

Defined In ​

createTreeWalker ​

Parameters ​

Returns ​

Example ​

Defined In ​

delete ​

Parameters ​

Returns ​

Defined In ​

forEach ​

Parameters ​

Class: XmlFragment

Extends

Constructors

constructor

Returns

Overrides

Defined In

Properties

_dEH

Defined In

Inherited from

_eH

Defined In

Inherited from

_item

Defined In

Inherited from

_length

Defined In

Inherited from

_map

Defined In

Inherited from

_prelimContent

Defined In

_searchMarker

Defined In

Inherited from

_start

Defined In

Inherited from

doc

Defined In

Inherited from

Accessors

_first

Defined In

Inherited from

firstChild

Defined In

length

Defined In

parent

Defined In

Inherited from

Methods

_callObserver

Parameters

Returns

Inherited from

Defined In

_copy

Returns

Overrides

Defined In

_integrate

Parameters

Returns

Overrides

Defined In

_write

Parameters

Returns

Inherited from

Defined In

clone

Returns

Overrides

Defined In

createTreeWalker

Parameters

Returns

Example

Defined In

delete

Parameters

Returns

Defined In

forEach

Parameters