diagram.api.utils package

Submodules

diagram.api.utils.edge module

diagram.api.utils.edge.create_edge(diagram, data, source, target)

Parameters:

• diagram (Diagram)

• data (Annotated[ControlFlow | ObjectFlow | Association | Composition | Generalization | Dependency | UsecaseRelation | Interface, FieldInfo(annotation=NoneType, required=True, discriminator='type')])

• source (Node)

• target (Node)

diagram.api.utils.edge.delete_relation_everywhere(diagram, edge_id)

Parameters:

• diagram (Diagram)

• edge_id (str)

diagram.api.utils.edge.fetch_and_update_edges(diagram)

Parameters:

diagram (Diagram)

diagram.api.utils.edge.remove_edge_from_diagram(diagram, edge_id)

Parameters:

• diagram (Diagram)

• edge_id (str)

diagram.api.utils.node module

diagram.api.utils.node.create_node(diagram, data)

Parameters:

• diagram (Diagram)

• data (Annotated[Annotated[SwimLane | SwimLaneGroup, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Action | Annotated[Decision | Final | Fork | Initial | Join | Merge, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Object | Event | Application | Page | Section | Class | Enum | Signal | Interface | Actor | Usecase | SystemBoundary | System | Container | Component, FieldInfo(annotation=NoneType, required=True, discriminator='type')])

diagram.api.utils.node.delete_classifier_everywhere(classifier_id)

Parameters:

classifier_id (str)

diagram.api.utils.node.remove_node(diagram, node_id)

Parameters:

• diagram (Diagram)

• node_id (str)

Module contents

diagram.api.utils.create_edge(diagram, data, source, target)

Parameters:

• diagram (Diagram)

• data (Annotated[ControlFlow | ObjectFlow | Association | Composition | Generalization | Dependency | UsecaseRelation | Interface, FieldInfo(annotation=NoneType, required=True, discriminator='type')])

• source (Node)

• target (Node)

diagram.api.utils.create_node(diagram, data)

Parameters:

• diagram (Diagram)

• data (Annotated[Annotated[SwimLane | SwimLaneGroup, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Action | Annotated[Decision | Final | Fork | Initial | Join | Merge, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Object | Event | Application | Page | Section | Class | Enum | Signal | Interface | Actor | Usecase | SystemBoundary | System | Container | Component, FieldInfo(annotation=NoneType, required=True, discriminator='type')])

diagram.api.utils.delete_classifier_everywhere(classifier_id)

Parameters:

classifier_id (str)

diagram.api.utils.delete_relation_everywhere(diagram, edge_id)

Parameters:

• diagram (Diagram)

• edge_id (str)

diagram.api.utils.get_diagram(request)

Return type:

Diagram | None

Parameters:

request (HttpRequest)

diagram.api.utils.import_node(diagram, id)

Parameters:

• diagram (Diagram)

• id (str)

diagram.api.utils.remove_edge_from_diagram(diagram, edge_id)

Parameters:

• diagram (Diagram)

• edge_id (str)

diagram.api.utils.remove_node(diagram, node_id)

Parameters:

• diagram (Diagram)

• node_id (str)