MermaidHtmlGenerator Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Graph.

Summary

Generate html for mermaid graphs of tasks

Assembly

Namespace

Cake.Graph.Generators

Interfaces

ITaskGraphGenerator

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["ITaskGraphGenerator"] click Interface0 "/api/Cake.Graph.Generators/ITaskGraphGenerator" Type["MermaidHtmlGenerator"] class Type type-node

Syntax

public class MermaidHtmlGenerator : ITaskGraphGenerator

Constructors

Name	Summary
MermaidHtmlGenerator()	MermaidHtmlGenerator
MermaidHtmlGenerator(IGraphTemplateManager)	MermaidHtmlGenerator

Properties

Name	Value	Summary
Extension	string	The file extension to use for this type of graph file
MermaidJsSource	string	Url/path for the mermaid js file

Methods

Name	Value	Summary
SerializeAsync(ICakeContext, ICakeTaskInfo, IReadOnlyList<ICakeTaskInfo>)	Task<string>	Converts the task to a graph and outputs the string for displaying

Extension Methods

Name	Value	Summary
Dump<MermaidHtmlGenerator>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MermaidHtmlGenerator>(MermaidHtmlGenerator[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MermaidHtmlGenerator>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<MermaidHtmlGenerator>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<MermaidHtmlGenerator>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<MermaidHtmlGenerator>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin