BlockSuite API Documentation / @blocksuite/store / Y / YXmlEvent
Class: YXmlEvent
Extends
YEvent
<XmlElement
<object
> |XmlFragment
|XmlText
>
Constructors
new YXmlEvent(target, subs, transaction)
new YXmlEvent(
target
,subs
,transaction
):YXmlEvent
Parameters
• target: XmlElement
<object
> | XmlFragment
| XmlText
The target on which the event is created.
• subs: Set
<null
| string
>
The set of changed attributes. null
is included if the child list changed.
• transaction: Transaction
The transaction instance with wich the change was created.
Returns
Overrides
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YXmlEvent.d.ts:15
Properties
_changes
_changes:
null
|Object
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:29
_delta
_delta:
null
|object
[]
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:41
_keys
_keys:
null
|Map
<string
,object
>
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:33
_path
_path:
null
| (string
|number
)[]
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:52
attributesChanged
attributesChanged:
Set
<string
>
Set of all changed attributes.
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YXmlEvent.d.ts:26
childListChanged
private
childListChanged:any
Whether the children changed.
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/types/YXmlEvent.d.ts:21
currentTarget
currentTarget:
AbstractType
<any
>
The current target on which the observe callback is called.
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:20
target
target:
XmlFragment
|XmlText
|XmlElement
<object
>
The type on which this event was created on.
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:15
transaction
transaction:
Transaction
The transaction that triggered this event.
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:25
Accessors
changes
get
changes():object
This is a computed property. Note that this can only be safely computed during the event call. Computing this property after other changes happened might result in unexpected behavior (incorrect computation of deltas). A safe way to collect changes is to store the changes
or the delta
object. Avoid storing the transaction
object.
Returns
object
added
added:
Set
<Item
>
deleted
deleted:
Set
<Item
>
delta
delta:
object
[]
keys
keys:
Map
<string
,object
>
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:117
delta
get
delta():object
[]
This is a computed property. Note that this can only be safely computed during the event call. Computing this property after other changes happened might result in unexpected behavior (incorrect computation of deltas). A safe way to collect changes is to store the changes
or the delta
object. Avoid storing the transaction
object.
Returns
object
[]
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:92
keys
get
keys():Map
<string
,object
>
Returns
Map
<string
, object
>
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:79
path
get
path(): (string
|number
)[]
Computes the path from y
to the changed type.
Todo
v14 should standardize on path: Array<\{parent, index\}>
because that is easier to work with.
The following property holds:
Example
let type = y
event.path.forEach(dir => {
type = type.get(dir)
})
type === event.target // => true
Returns
(string
| number
)[]
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:66
Methods
adds()
adds(
struct
):boolean
Check if a struct is added by this event.
In contrast to change.deleted, this method also returns true if the struct was added and then deleted.
Parameters
• struct: AbstractStruct
Returns
boolean
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:108
deletes()
deletes(
struct
):boolean
Check if a struct is deleted by this event.
In contrast to change.deleted, this method also returns true if the struct was added and then deleted.
Parameters
• struct: AbstractStruct
Returns
boolean
Inherited from
Source
node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:75