Class clavaFlowDotFormatter<G>

Type Parameters

Hierarchy

  • default<G>
    • clavaFlowDotFormatter

Constructors

constructor

Properties

getContainer getEdgeAttrs getGraphAttrs getNodeAttrs cfgDefaultEdgeColor cfgEdgeTransparency cfgEndNodeSize cfgNodeColor cfgNodeDarkColor codeFontSize falseColor functionColor functionDarkColor functionFontSize jumpScopeTransparency keywordColor locationFontColor locationFontSize symbolColor trueColor

Methods

addEdgeAttrs addGraphAttrs addNodeAttrs clusterNodeToDot containedNodes edgeToDot format isContained isContainer nodeToDot toDot defaultGetContainer defaultGetEdgeAttrs defaultGetGraphAttrs defaultGetNodeAttrs renderComment renderKeyword renderLineNumber renderNodeLabel renderSymbol renderUnknownNode renderValue

Constructors

constructor

Properties

getContainer

getContainer: ((node: Class<Data, ScratchData>) => undefined | Class<Data, ScratchData>)

Given a node, returns the node that will contain it. By default that is the parent of the node, but subclasses may override this method to visualize other parent-like relationships.

getEdgeAttrs

getEdgeAttrs: ((edge: Class<Data, ScratchData>) => Record<string, string>)

The attributes to add to each edge.

getGraphAttrs

getGraphAttrs: (() => Record<string, string>)

The attributes to add to the graph.

getNodeAttrs

getNodeAttrs: ((node: Class<Data, ScratchData>) => Record<string, string>)

The attributes to add to each node.

StaticcfgDefaultEdgeColor

cfgDefaultEdgeColor: string

StaticcfgEdgeTransparency

cfgEdgeTransparency: string

StaticcfgEndNodeSize

cfgEndNodeSize: string

StaticcfgNodeColor

cfgNodeColor: string

StaticcfgNodeDarkColor

cfgNodeDarkColor: string

StaticcodeFontSize

codeFontSize: string = "10"

StaticfalseColor

falseColor: string = "#d10202"

StaticfunctionColor

functionColor: string

StaticfunctionDarkColor

functionDarkColor: string

StaticfunctionFontSize

functionFontSize: string

StaticjumpScopeTransparency

jumpScopeTransparency: string = "8f"

StatickeywordColor

keywordColor: string = "#4040e0"

StaticlocationFontColor

locationFontColor: string = "#c0c0c0"

StaticlocationFontSize

locationFontSize: string = "9"

StaticsymbolColor

symbolColor: string = "#8080a0"

StatictrueColor

trueColor: string = "#7bc706"

Methods

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: Class<Data, ScratchData>) => Record<string, string>)

      The function that adds attributes to each edge.

        • (edge): Record<string, string>

        • Parameters

          • edge: Class<Data, 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: Class<Data, ScratchData>) => Record<string, string>)

      The function that adds attributes to each node.

        • (node): Record<string, string>

        • Parameters

          • node: Class<Data, 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: Class<Data, ScratchData>

      The node to convert.

    Returns DotSubgraph

    The resulting DOT subgraph.

containedNodes

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

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

    Parameters

    • node: Class<Data, ScratchData>

      The node to get the contained nodes of.

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

    The nodes that are contained by the given node.

edgeToDot

  • edgeToDot(edge): DotEdge

  • Converts an edge into a DOT edge.

    Parameters

    • edge: Class<Data, ScratchData>

      The edge to convert.

    Returns DotEdge

    The resulting DOT edge.

format

  • format(graph): string

  • Converts a graph to a DOT string.

    Parameters

    • graph: G

      The graph to convert.

    Returns string

    The resulting DOT string.

isContained

  • isContained(node): boolean

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

    Parameters

    • node: Class<Data, 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: Class<Data, 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: Class<Data, 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 | Class<Data, ScratchData>

  • Prioritizes the parent of the node as the container. Otherwise, for a ControlFlowNode, its function is used.

    Parameters

    • node: Class<Data, ScratchData>

      The node to find the container of.

    Returns undefined | Class<Data, ScratchData>

    The parent of the node.

StaticdefaultGetEdgeAttrs

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

  • Parameters

    • edge: Class<Data, 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>

  • Parameters

    • node: Class<Data, ScratchData>

      The node to get the attributes for.

    Returns Record<string, string>

    The attributes of the node.

StaticrenderComment

StaticrenderKeyword

StaticrenderLineNumber

StaticrenderNodeLabel

StaticrenderSymbol

StaticrenderUnknownNode

StaticrenderValue

Settings

Member Visibility

On This Page

Constructors
Properties
Methods