GraphSettings Class

Summary

Settings for creating the graph files
Assembly
Cake.Graph.dll
Namespace
Cake.Graph
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GraphSettings"] class Type type-node

Syntax

public class GraphSettings

Constructors

Name Summary
GraphSettings()

Properties

Name Value Summary
Generator ITaskGraphGenerator
The generator which will convert the task and dependencies to a string
OutputPath string
Root folder to deploy content to

Extension Methods

Name Value Summary
Dump<GraphSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GraphSettings>(GraphSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GraphSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GraphSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetOutputPath(string) GraphSettings
Root path for deploying all files
Requires the Cake.Graph addin
ThrowIfNull<GraphSettings>(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<GraphSettings>(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
WithCustomGenerator(ITaskGraphGenerator) GraphSettings
Use a custom generator
Requires the Cake.Graph addin
WithCytoscapeGenerator() GraphSettings
Use a generator which outputs in cytoscape syntax
Requires the Cake.Graph addin
WithCytoscapeHtmlGenerator() GraphSettings
Use a generator which outputs separate files with cytoscape graphs
Requires the Cake.Graph addin
WithCytoscapeWyamGenerator() GraphSettings
Use a generator which outputs separate files for wyam with cytoscape graphs
Requires the Cake.Graph addin
WithMermaidGenerator() GraphSettings
Use a generator which outputs in mermaid syntax
Requires the Cake.Graph addin
WithMermaidHtmlGenerator() GraphSettings
Use a generator which outputs separate files with mermaid graphs
Requires the Cake.Graph addin