Class defaultDotFormatter<G>

constructor

• new defaultDotFormatter<G>(getNodeAttrs?, getEdgeAttrs?, getContainer?, getGraphAttrs?): defaultDotFormatter<G>

• Creates a new default DOT formatter.

  Type Parameters

  • G extends BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData> = BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>

  Parameters

  • OptionalgetNodeAttrs: ((node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>) => Record<string, string>)

    The attributes to add to each node. If not provided, the default attributes are used.

    • • (node): Record<string, string>

      • Parameters

        • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

        Returns Record<string, string>

  • OptionalgetEdgeAttrs: ((edge: BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>) => Record<string, string>)

    The attributes to add to each edge. If not provided, the default attributes are used.

    • • (edge): Record<string, string>

      • Parameters

        • edge: BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>

        Returns Record<string, string>

  • OptionalgetContainer: ((node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>) => undefined | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>)

    Given a node, returns the node that will contain it.

    • • (node): undefined | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

      • Parameters

        • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

        Returns undefined | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

  • OptionalgetGraphAttrs: (() => Record<string, string>)
    • • (): Record<string, string>

      • Returns Record<string, string>

  Returns defaultDotFormatter<G>

getContainer

getEdgeAttrs

getGraphAttrs

getNodeAttrs

addEdgeAttrs

• addEdgeAttrs(f): this

• Adds attributes to each edge. Only overrides the attributes that are explicitly set by the function, leaving the others unchanged.

  For completely overriding the previous attributes, just set getEdgeAttrs directly.

  Parameters

  • f: ((edge: BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>) => Record<string, string>)

    The function that adds attributes to each edge.

    • • (edge): Record<string, string>

      • Parameters

        • edge: BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>

        Returns Record<string, string>

  Returns this

  The same formatter, for chaining.

addGraphAttrs

• addGraphAttrs(f): this

• Adds attributes to the graph. Only overrides the attributes that are explicitly set by the function, leaving the others unchanged.

  For completely overriding the previous attributes, just set getGraphAttrs directly.

  Parameters

  • f: (() => Record<string, string>)

    The function that adds attributes to the graph.

    • • (): Record<string, string>

      • Returns Record<string, string>

  Returns this

  The same formatter, for chaining.

addNodeAttrs

• addNodeAttrs(f): this

• Adds attributes to each node. Only overrides the attributes that are explicitly set by the function, leaving the others unchanged.

  For completely overriding the previous attributes, just set getNodeAttrs directly.

  Parameters

  • f: ((node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>) => Record<string, string>)

    The function that adds attributes to each node.

    • • (node): Record<string, string>

      • Parameters

        • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

        Returns Record<string, string>

  Returns this

  The same formatter, for chaining.

clusterNodeToDot

• clusterNodeToDot(node): DotSubgraph

• Converts a node with children into a DOT subgraph.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to convert.

  Returns DotSubgraph

  The resulting DOT subgraph.

containedNodes

• containedNodes(node): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

• Retrieves all nodes that are contained by a node. This method is based on getContainer.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to get the contained nodes of.

  Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

  The nodes that are contained by the given node.

edgeToDot

• edgeToDot(edge): DotEdge

• Converts an edge into a DOT edge.

  Parameters

  • edge: BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>

    The edge to convert.

  Returns DotEdge

  The resulting DOT edge.

isContained

• isContained(node): boolean

• Checks if a node is contained by another node. This is based on getContainer.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to check.

  Returns boolean

  Whether the node is contained by another node.

isContainer

• isContainer(node): boolean

• Checks if a node contains other nodes. This is based on getContainer.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to check.

  Returns boolean

  Whether the node contains other nodes.

nodeToDot

• nodeToDot(node): DotNode

• Converts a node without children into a DOT node.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to convert.

  Returns DotNode

  The resulting DOT node.

toDot

• toDot(graph): DotGraph

• Converts a graph into a DOT graph.

  Parameters

  • graph: G

    The graph to convert.

  Returns DotGraph

  The resulting DOT graph.

StaticdefaultGetContainer

• defaultGetContainer(node): undefined | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

• The default method for finding the container of a node.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to find the container of.

  Returns undefined | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

  The parent of the node.

StaticdefaultGetEdgeAttrs

• defaultGetEdgeAttrs(edge): Record<string, string>

• The default attributes of an edge.

  Parameters

  • edge: BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>

    The edge to get the attributes for.

  Returns Record<string, string>

  The attributes of the edge.

StaticdefaultGetGraphAttrs

• defaultGetGraphAttrs(): Record<string, string>

• The default attributes of a graph.

  Returns Record<string, string>

  The attributes of the graph.

StaticdefaultGetNodeAttrs

• defaultGetNodeAttrs(node): Record<string, string>

• The default attributes of a node.

  Parameters

  • node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>

    The node to get the attributes for.

  Returns Record<string, string>

  The attributes of the node.