#FlowNodeEntity/WorkflowNodeEntity

Node entity, WorkflowNodeEntity is the alias for the node used for free layout nodes, the node entity uses the ECS architecture, is Entity

> API Detail

#Properties

• id: string Node id
• flowNodeType: string | number Node type
• version number Node version, can be used to determine if the node state has been updated

#Accessors

• document: FlowDocument | WorkflowDocument Document link
• bounds: Rectangle Get the node's x, y, width, height, equivalent to transform.bounds
• blocks: FlowNodeEntity[] Get child nodes, including collapsed child nodes, equivalent to collapsedChildren
• collapsedChildren: FlowNodeEntity[] Get child nodes, including collapsed child nodes
• allCollapsedChildren: FlowNodeEntity[] Get all child nodes, including all collapsed child nodes
• children: FlowNodeEntity[] Get child nodes, not including collapsed child nodes
• pre: FlowNodeEntity | undefined Get the previous node
• next: FlowNodeEntity | undefined Get the next node
• parent: FlowNodeEntity | undefined Get the parent node
• originParent: FlowNodeEntity | undefined Get the original parent node, this is used to find the entire virtual branch for the first node of the fixed layout branch (orderIcon)
• allChildren: FlowNodeEntity[] Get all child nodes, not including collapsed child nodes
• transform: FlowNodeTransformData Get the node's transform matrix data
• renderData: FlowNodeRenderData Get the node's render data, including render status
• form: NodeFormProps Get the node's form data, like getNodeForm
• scope: FlowNodeScope Get the node's variable public scope
• privateScope: FlowNodeScope Get the node's variable private scope
• lines: WorkflowNodeLinesData Get the node's lines data (Only FreeLayout)
• ports: WorkflowNodePortsData Get the node's ports data (Only FreeLayout)

#Methods

#getExtInfo

Get the node's extended information, can be updated through updateExtInfo

node.getExtInfo<{ test: string }>()

#updateExtInfo

Update extended data, update will not be recorded in redo/undo, if you need to record, please implement the history service

node.updateExtInfo<{ test: string }>({
  test: 'test'
})

#getNodeRegistry

Get the node registry, equivalent to ctx.document.getNodeRegistry(node.flowNodeType)

const nodeRegistry = node.getNodeRegistry<FlowNodeRegistry>()

#getData

Equivalent to getting the Component of Entity in the ECS architecture, currently built-in two core Components

node.getData(FlowNodeTransformData) // transform matrix data, including the node's x, y, width, height, etc.
node.getData(FlowNodeRenderData) // node render data, including render status

#addData

Equivalent to adding the Component of Entity in the ECS architecture

// Custom EntityData
class CustomEntityData extends EntityData<{ key0: string }> {
  static type = 'CustomEntityData';
  getDefaultData() {
    return {
      key0: 'test'
    }
  }
}

// Add Entity Component
node.addData(CustomEntityData)


// Update Entity Component data
node.getData(CustomEntityData).update({ key0: 'new value' })

#getService

Node access IOC service

node.getService(SelectionService)

#dispose

Node destruction from canvas

#onDispose

Node destruction event

useEffect(() => {
  const toDispose = node.onDispose(() => {
    console.log('Dispose node')
  })
  return () => toDispose.dispose()
}, [node])

#toJSON

Export node data