MxMermaidGraphExporter Class Reference

Class which will export a graph to Mermaid format. More...

Public Member Functions
	constructor (graphDictionary, connections)
	Constructor.
	setOrientation (orientation)
	Set the orientation of the graph.
	setEmitCategory (emitCategory)
	Set the emit the category versus the node name.
	setEmitType (emitType)
	Emit the type of each node in the graph.
	sanitizeString (path)
	Sanitize the a node path to be safe to use with Mermaid.
	execute ()
	Build the graph.
	write (filename)
	Write the graph to a file.
	getGraph (wrap=true)
	Get the graph wrapped in a code block if desired.
	export ()

Detailed Description

Class which will export a graph to Mermaid format.

Definition at line 471 of file JsMaterialXGraph.js.

Member Function Documentation

constructor()

MxMermaidGraphExporter::constructor	(		graphDictionary,
			connections )

Constructor.

Parameters

graphDictionary	Set of graph elements organized by node graph
connections	Set of connections between graph elements

Returns

{void}

Definition at line 479 of file JsMaterialXGraph.js.

                                              {
        this.graphDictionary = graphDictionary;
        this.connections = connections;
        this.mermaid = [];
        this.orientation = 'LR';
        this.emitCategory = false;
        this.emitType = false;
    }

execute()

MxMermaidGraphExporter::execute

(

)

Build the graph.

Scans the graph dictionary to create the list of nodes per graph and then scans the connections to create the list of connections between nodes. Specific shapes and colours are assigned for different node types.

Returns

Mermaid graph

Definition at line 537 of file JsMaterialXGraph.js.

              {
        let mermaid = [];
        mermaid.push(`graph ${this.orientation}`);
        
        for (let graphPath in this.graphDictionary) {
            let isSubgraph = graphPath !== '';
            if (isSubgraph) {
                mermaid.push(`    subgraph ${graphPath}`);
            }
            
            for (let item of this.graphDictionary[graphPath]) {
                let path = item[0];
                let label = path.split('/').pop();
                // Sanitize the path name
                path = this.sanitizeString(path)
                
                if (this.emitCategory) {
                    label = item[1];
                }
                
                if (this.emitType) {
                    label += `:${item[2]}`;
                }
                
                if (item[3]) {
                    label += `:${item[3]}`;
                }
                
                if (['input', 'output'].includes(item[1])) {
                    mermaid.push(`    ${path}([${label}])`);
                    mermaid.push(`    style ${path}  fill:#09D, color:#FFF`);
                } else if (item[1] === 'surfacematerial') {
                    mermaid.push(`    ${path}([${label}])`);
                    mermaid.push(`    style ${path}   fill:#090, color:#FFF`);
                } else if (item[1] === 'nodedef') {
                    mermaid.push(`    ${path}[[${label}]]`);
                    //mermaid.push(`    style ${path}  fill:#02F, color:#FFF`);
                } else if (['ifequal', 'ifgreatereq', 'switch'].includes(item[1])) {
                    mermaid.push(`    ${path}{${label}}`);
                    mermaid.push(`    style ${path}   fill:#C72, color:#FFF`);
                } else if (item[1] === 'token') {
                    mermaid.push(`    ${path}{{${label}}}`);
                    mermaid.push(`    style ${path}  fill:#222, color:#FFF`);
                } else if (item[1] === 'constant') {
                    mermaid.push(`    ${path}([${label}])`);
                    mermaid.push(`    style ${path}  fill:#888, color:#000`);
                } else {
                    mermaid.push(`    ${path}[${label}]`);
                }
            }
            
            if (isSubgraph) {
                mermaid.push('    end');
            }
        }
        
        this.mermaid = mermaid;
        
        for (let connection of this.connections) 
        {
            // Sanitize path names
            connection[0] = this.sanitizeString(connection[0])
            connection[2] = this.sanitizeString(connection[2])
 
            let source = connection[0];
            let dest = connection[2];
            let edge = '';
 
            if (connection[1].length > 0) {
                if (connection[3].length > 0) {
                    edge = `${connection[1]}-->${connection[3]}`;
                } else {
                    edge = connection[1];
                }
            } else {
                edge = connection[3];
            }
 
            let connectString = '';
 
            if (connection[4] === 'value') {
                let sourceNode = source.split('/').pop();
                connectString = edge.length > 0 
                    ? `    ${sourceNode}["${source}"] --${edge}--> ${dest}`
                    : `    ${sourceNode}["${source}"] --> ${dest}`;
            } else {
                connectString = edge.length > 0 
                    ? `    ${source} --"${edge}"--> ${dest}`
                    : `    ${source} --> ${dest}`;
            }
 
            mermaid.push(connectString);
        }
 
        return mermaid;
    }

export()

MxMermaidGraphExporter::export

(

)

Definition at line 657 of file JsMaterialXGraph.js.

             {
        return this.getGraph();
    }

getGraph()

MxMermaidGraphExporter::getGraph

(

wrap = true

)

Get the graph wrapped in a code block if desired.

Parameters

wrap	Wrap the graph in a Markdown code block

Definition at line 648 of file JsMaterialXGraph.js.

                          {
        let result = wrap 
            ? '```mermaid\n' + this.mermaid.join('\n') + '\n```'
            : this.mermaid.join('\n');
 
        result = result.replace('/default', '/default1');
        return result;
    }

sanitizeString()

MxMermaidGraphExporter::sanitizeString

(

path

)

Sanitize the a node path to be safe to use with Mermaid.

Parameters

path	Original path

Returns

sanitized path

Definition at line 520 of file JsMaterialXGraph.js.

    {
        path = path.replace('/default', '/default1');
        path = path.replace('/', '_');
        path = path.replace(' ', '_');
        return path;
    }

setEmitCategory()

MxMermaidGraphExporter::setEmitCategory

(

emitCategory

)

Set the emit the category versus the node name.

Parameters

emitCategory

Returns

{void}

Definition at line 502 of file JsMaterialXGraph.js.

                                  {
        this.emitCategory = emitCategory;
    }

setEmitType()

MxMermaidGraphExporter::setEmitType

(

emitType

)

Emit the type of each node in the graph.

Parameters

emitType

Returns

{void}

Definition at line 511 of file JsMaterialXGraph.js.

                          {
        this.emitType = emitType;
    }

setOrientation()

MxMermaidGraphExporter::setOrientation

(

orientation

)

Set the orientation of the graph.

Parameters

orientation

Returns

{void}

Definition at line 493 of file JsMaterialXGraph.js.

                                {
        this.orientation = orientation;
    }

write()

MxMermaidGraphExporter::write

(

filename

)

Write the graph to a file.

Parameters

filename

Returns

{void}

Definition at line 639 of file JsMaterialXGraph.js.

                    {
        let fs = require('fs');
        fs.writeFileSync(filename, this.export());
    }

---

The documentation for this class was generated from the following file:

• JsMaterialXGraph.js