Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

View on GitHub Releases Get package
Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

TerminalStoryExtensions

Namespace ChartForgeX.Terminal
Assembly ChartForgeX.Stories
Modifiers static

Exports terminal story playback and completed images.

Inheritance

  • Object
  • TerminalStoryExtensions

Methods

public static Void SaveApng(TerminalStory story, String path, TerminalStoryAnimationOptions? options = null) #
Returns: Void

Saves a terminal story as an animated PNG.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Terminal.TerminalStoryAnimationOptions? = null optionalposition: 2
public static Void SaveGif(TerminalStory story, String path, TerminalStoryAnimationOptions? options = null) #
Returns: Void

Saves a terminal story as an animated GIF.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Terminal.TerminalStoryAnimationOptions? = null optionalposition: 2
public static Void SaveHtml(TerminalStory story, String path) #
Returns: Void

Saves a terminal story as a complete HTML document.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
path System.String requiredposition: 1
public static Void SavePng(TerminalStory story, String path) #
Returns: Void

Saves the completed state of a terminal story as PNG.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
path System.String requiredposition: 1
public static Void SaveSvg(TerminalStory story, String path) #
Returns: Void

Saves a terminal story as SVG.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
path System.String requiredposition: 1
public static Void SaveTranscript(TerminalStory story, String path) #
Returns: Void

Saves the exact terminal transcript as UTF-8 text.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
path System.String requiredposition: 1
public static Byte[] ToApng(TerminalStory story, TerminalStoryAnimationOptions? options = null) #
Returns: Byte[]

Renders a terminal story as an animated PNG.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
options ChartForgeX.Terminal.TerminalStoryAnimationOptions? = null optionalposition: 1
public static Byte[] ToGif(TerminalStory story, TerminalStoryAnimationOptions? options = null) #
Returns: Byte[]

Renders a terminal story as an animated GIF.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
options ChartForgeX.Terminal.TerminalStoryAnimationOptions? = null optionalposition: 1
ToHtmlFragment 2 overloads
public static String ToHtmlFragment(TerminalStory story) #
Returns: String

Renders a terminal story as an embeddable HTML fragment.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
public static String ToHtmlFragment(TerminalStory story, String idScope) #
Returns: String

Renders a terminal story as an embeddable HTML fragment with a deterministic ID scope.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
idScope System.String requiredposition: 1
public static String ToHtmlPage(TerminalStory story) #
Returns: String

Renders a terminal story as a complete HTML document.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
public static Byte[] ToPng(TerminalStory story) #
Returns: Byte[]

Renders the completed state of a terminal story to PNG bytes.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
ToSvg 2 overloads
public static String ToSvg(TerminalStory story) #
Returns: String

Renders a terminal story to SVG markup.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
public static String ToSvg(TerminalStory story, String idScope) #
Returns: String

Renders a terminal story to SVG markup with a deterministic ID scope.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0
idScope System.String requiredposition: 1
public static String ToTranscript(TerminalStory story) #
Returns: String

Exports the exact command, output and table transcript in playback order.

Parameters

story ChartForgeX.Terminal.TerminalStory requiredposition: 0

Exceptions

  • InvalidOperationException – The expanded transcript exceeds 16 Mi UTF-16 characters.