MermaidHtmlGenerator Class

Summary

Generate html for mermaid graphs of tasks
Assembly
Cake.Graph.dll
Namespace
Cake.Graph.Generators
Interfaces
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.
Requires the Cake.Incubator addin
IsIn<MermaidHtmlGenerator>(MermaidHtmlGenerator[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MermaidHtmlGenerator>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MermaidHtmlGenerator>(string) void
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
Requires the Cake.Incubator addin
ThrowIfNull<MermaidHtmlGenerator>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Requires the Cake.Issues addin