GoJS API
/ to search
    Preparing search index...

    Interface IncrementalData<NodeDataType, LinkDataType, SharedDataType>

    GoJS® Diagramming Components
    version 4.0.1
    by Northwoods Software®

    Interface for the output object of Model.toIncrementalData.

    All properties of this object are optional, as they are only included if changes occurred. For instance, if a transaction didn't include any changes to modelData, the modelData property of this interface won't be included on the output object.

    Any shared or cyclic references within the model data will be maintained on the data included on this output object.

    since

    2.1

    interface IncrementalData<
        NodeDataType extends ObjectData = ObjectData,
        LinkDataType extends ObjectData = ObjectData,
        SharedDataType extends ObjectData = ObjectData,
    > {
        insertedLinkKeys?: Key[];
        insertedNodeKeys?: Key[];
        modelData?: SharedDataType;
        modifiedLinkData?: LinkDataType[];
        modifiedNodeData?: NodeDataType[];
        removedLinkKeys?: Key[];
        removedNodeKeys?: Key[];
    }

    Type Parameters

    Index

    Properties

    insertedLinkKeys? insertedNodeKeys? modelData? modifiedLinkData? modifiedNodeData? removedLinkKeys? removedNodeKeys?

    Properties

    insertedLinkKeys?: Key[]

    Array of link keys added. Any key included will also be included in the modifiedLinkData array.

    insertedNodeKeys?: Key[]

    Array of node keys added. Any key included will also be included in the modifiedNodeData array.

    modelData?: SharedDataType

    Object containing the modified Model.modelData.

    modifiedLinkData?: LinkDataType[]

    Array of link data objects modified.

    modifiedNodeData?: NodeDataType[]

    Array of node data objects modified.

    removedLinkKeys?: Key[]

    Array of link keys deleted.

    removedNodeKeys?: Key[]

    Array of node keys deleted.

    Member Visibility

    On This Page

    Properties