Class DefaultDotFormatter<G>

constructor

• new DefaultDotFormatter<
      G extends
          BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData> = BaseGraph.Class<
          BaseGraph.Data,
          BaseGraph.ScratchData,
      >,
  >(
      getNodeAttrs?: (node: BaseNode.Class) => Record<string, string>,
      getEdgeAttrs?: (edge: BaseEdge.Class) => Record<string, string>,
      getContainer?: (
          node: BaseNode.Class,
      ) => BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined,
      getGraphAttrs?: () => Record<string, string>,
  ): DefaultDotFormatter<G>

  Creates a new default DOT formatter.

  Type Parameters

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

    The type of the graph. This parameter exists so that the formatter may be extended into a formatter that requires a more specific graph type.

  Parameters

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

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

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

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

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

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

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

  Returns DefaultDotFormatter<G>

getContainer

getEdgeAttrs

getGraphAttrs

getNodeAttrs

addEdgeAttrs

• addEdgeAttrs(f: (edge: BaseEdge.Class) => Record<string, string>): 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) => Record<string, string>

    The function that adds attributes to each edge.

  Returns this

  The same formatter, for chaining.

addGraphAttrs

• addGraphAttrs(f: () => Record<string, string>): 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.

  Returns this

  The same formatter, for chaining.

addNodeAttrs

• addNodeAttrs(f: (node: BaseNode.Class) => Record<string, string>): 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) => Record<string, string>

    The function that adds attributes to each node.

  Returns this

  The same formatter, for chaining.

clusterNodeToDot

• clusterNodeToDot(node: BaseNode.Class): DotSubgraph

  Converts a node with children into a DOT subgraph.

  Parameters

  • node: BaseNode.Class

    The node to convert.

  Returns DotSubgraph

  The resulting DOT subgraph.

containedNodes

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

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

  Parameters

  • node: BaseNode.Class

    The node to get the contained nodes of.

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

  The nodes that are contained by the given node.

edgeToDot

• edgeToDot(edge: BaseEdge.Class): DotEdge

  Converts an edge into a DOT edge.

  Parameters

  • edge: BaseEdge.Class

    The edge to convert.

  Returns DotEdge

  The resulting DOT edge.

isContained

• isContained(node: BaseNode.Class): boolean

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

  Parameters

  • node: BaseNode.Class

    The node to check.

  Returns boolean

  Whether the node is contained by another node.

isContainer

• isContainer(node: BaseNode.Class): boolean

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

  Parameters

  • node: BaseNode.Class

    The node to check.

  Returns boolean

  Whether the node contains other nodes.

nodeToDot

• nodeToDot(node: BaseNode.Class): DotNode

  Converts a node without children into a DOT node.

  Parameters

  • node: BaseNode.Class

    The node to convert.

  Returns DotNode

  The resulting DOT node.

toDot

• toDot(graph: G): DotGraph

  Converts a graph into a DOT graph.

  Parameters

  • graph: G

    The graph to convert.

  Returns DotGraph

  The resulting DOT graph.

StaticdefaultGetContainer

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

  The default method for finding the container of a node.

  Parameters

  • node: BaseNode.Class

    The node to find the container of.

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

  The parent of the node.

StaticdefaultGetEdgeAttrs

• defaultGetEdgeAttrs(edge: BaseEdge.Class): Record<string, string>

  The default attributes of an edge.

  Parameters

  • edge: BaseEdge.Class

    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: BaseNode.Class): Record<string, string>

  The default attributes of a node.

  Parameters

  • node: BaseNode.Class

    The node to get the attributes for.

  Returns Record<string, string>

  The attributes of the node.