fundamentals-platform
API
Generated with
fundamentals-platform/izumi.fundamentals.platform.graphs.dotml/Backend

Backend

izumi.fundamentals.platform.graphs.dotml.Backend$
object Backend

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Backend.type

Members list

Concise view

Value members

Concrete methods

def command(engine: String, format: String, filePath: String): (String, String)

Return command for execution and name of the rendered file.

Return command for execution and name of the rendered file.

Attributes

engine

The layout commmand used for rendering ('dot', 'neato', ...).

filePath

The output path of the source file.

format

The output format used for rendering ('pdf', 'png', ...).

Returns:

render command to execute.

def doRender(engine: String, format: String, filePath: String): String

Render file with Graphviz engine into format, return result filename.

Render file with Graphviz engine into format, return result filename.

Attributes

engine

The layout commmand used for rendering ('dot', 'neato', ...).

filepath

Path to the DOT source file to render.

format

The output format used for rendering ('pdf', 'png', ...).

def doView(filePath: String): Unit

Open filepath with its default viewing application (platform-specific). For know only support linux.

Open filepath with its default viewing application (platform-specific). For know only support linux.

Attributes

def render(graphVizDotML: GraphVizDotML, engine: String, format: String, fileName: String, directory: String, view: Boolean, cleanUp: Boolean): String

Save the source to file and render with the Graphviz engine.

Save the source to file and render with the Graphviz engine.

Attributes

cleanup

Whether delete the source file after rendering.

directory

Directory to save the Dot source file.

engine

The layout commmand used for rendering ('dot', 'neato', ...).

fileName

Name of the DOT source file to render.

format

The output format used for rendering ('pdf', 'png', ...).

view

Whether open the rendered result with the default application.

Returns:

The (possibly relative) path of the rendered file.

def view(graphVizDotML: GraphVizDotML, engine: String, format: String, fileName: String, directory: String, cleanUp: Boolean): String

Save the source to file, open the rendered result in a viewer.

Save the source to file, open the rendered result in a viewer.

Attributes

cleanup

Whether delete the source file after rendering.

directory

Directory to save the Dot source file.

engine

The layout commmand used for rendering ('dot', 'neato', ...).

fileName

Name of the DOT source file to render.

format

The output format used for rendering ('pdf', 'png', ...).

Returns:

The (possibly relative) path of the rendered file.

Generated with