ArrayNodeTreeChangedRetainOp Interface
A "retain" op in an ArrayNodeTreeChangedDeltaOp sequence, used in NodeChangedDataTreeDelta payloads delivered to treeChanged on array nodes.
Extends ArrayNodeRetainOp with a subtreeChanged flag that indicates whether any descendant of the retained element changed.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface ArrayNodeTreeChangedRetainOp extends ArrayNodeRetainOp
Extends: ArrayNodeRetainOp
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| subtreeChanged | Alpha | readonly | boolean | Whether any descendant of this retained element changed. true if the element's subtree changed; false if nothing changed within it. |
Property Details
subtreeChanged
Whether any descendant of this retained element changed. true if the element's subtree changed; false if nothing changed within it.
For more information about our API support guarantees, see here.
Signature
readonly subtreeChanged: boolean;
Type: boolean
Remarks
Subscribe to nodeChanged or treeChanged on the element node itself for details.