Project

ChartForgeX

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

View on GitHub Visit Website Releases Get package
Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

TerminalStory

Namespace ChartForgeX.Terminal

Models a deterministic, script-free animated terminal presentation.

Inheritance

  • Object
  • TerminalStory

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

Blank() #

Adds a blank output line.

Command(System.String arg1, System.Double arg2) #

Adds a typed command.

Parameters

arg1 System.String required
arg2 System.Double required
Create() #

Creates an empty terminal story.

DeclareTab(System.String arg1, System.String arg2, ChartForgeX.Terminal.TerminalDialect arg3, System.String arg4, ChartForgeX.Terminal.TerminalTheme arg5, ChartForgeX.Terminal.TerminalTabIcon arg6, System.String arg7) #

Declares a persistent terminal tab without changing the active tab.

Parameters

arg1 System.String required
arg2 System.String required
arg3 ChartForgeX.Terminal.TerminalDialect required
arg4 System.String required
arg5 ChartForgeX.Terminal.TerminalTheme required
arg6 ChartForgeX.Terminal.TerminalTabIcon required
arg7 System.String required
OpenTab(System.String arg1, System.String arg2, ChartForgeX.Terminal.TerminalDialect arg3, System.String arg4, ChartForgeX.Terminal.TerminalTheme arg5, ChartForgeX.Terminal.TerminalTabIcon arg6, System.String arg7, System.Double arg8) #

Declares and activates a persistent terminal tab.

Parameters

arg1 System.String required
arg2 System.String required
arg3 ChartForgeX.Terminal.TerminalDialect required
arg4 System.String required
arg5 ChartForgeX.Terminal.TerminalTheme required
arg6 ChartForgeX.Terminal.TerminalTabIcon required
arg7 System.String required
arg8 System.Double required
Output(System.String arg1, ChartForgeX.Terminal.TerminalTextTone arg2) #

Adds one or more output lines.

Parameters

arg1 System.String required
arg2 ChartForgeX.Terminal.TerminalTextTone required
Pause(System.Double arg1) #

Adds a silent pause to the animation timeline.

Parameters

arg1 System.Double required
Progress(System.String arg1, System.Double arg2, System.Int32 arg3) #

Adds a compact text progress bar.

Parameters

arg1 System.String required
arg2 System.Double required
arg3 System.Int32 required
SelectTab(System.String arg1, System.Double arg2) #

Activates a previously declared terminal tab without clearing its buffer.

Parameters

arg1 System.String required
arg2 System.Double required
Table(ChartForgeX.Terminal.TerminalTable arg1) #

Adds a formatted terminal table.

Parameters

arg1 ChartForgeX.Terminal.TerminalTable required
Transcript(System.Collections.Generic.IEnumerable{System.String} arg1, ChartForgeX.Terminal.TerminalTextTone arg2) #

Adds captured transcript lines.

Parameters

arg1 System.Collections.Generic.IEnumerable{System.String} required
arg2 ChartForgeX.Terminal.TerminalTextTone required
WithDialect(ChartForgeX.Terminal.TerminalDialect arg1, System.String arg2) #

Sets the prompt dialect and optional custom prompt.

Parameters

arg1 ChartForgeX.Terminal.TerminalDialect required
arg2 System.String required
WithFinalPrompt(System.Boolean arg1) #

Configures whether the completed story shows a final prompt.

Parameters

arg1 System.Boolean required
WithInitialTab(System.String arg1, System.String arg2, ChartForgeX.Terminal.TerminalDialect arg3, System.String arg4, ChartForgeX.Terminal.TerminalTheme arg5, ChartForgeX.Terminal.TerminalTabIcon arg6, System.String arg7) #

Defines the initial persistent terminal tab before timeline authoring begins.

Parameters

arg1 System.String required
arg2 System.String required
arg3 ChartForgeX.Terminal.TerminalDialect required
arg4 System.String required
arg5 ChartForgeX.Terminal.TerminalTheme required
arg6 ChartForgeX.Terminal.TerminalTabIcon required
arg7 System.String required
WithPlaybackSpeed(ChartForgeX.Terminal.TerminalStoryPlaybackSpeed arg1) #

Applies a reusable playback pace for typing, output reveals, and tab reading time.

Parameters

arg1 ChartForgeX.Terminal.TerminalStoryPlaybackSpeed required
WithPngOutputScale(System.Int32 arg1) #

Sets the PNG output density multiplier.

Parameters

arg1 System.Int32 required
WithTabHold(System.Double arg1) #

Sets the minimum reading time after new content appears and before the active tab changes.

Parameters

arg1 System.Double required
WithTheme(ChartForgeX.Terminal.TerminalTheme arg1) #

Sets the terminal theme.

Parameters

arg1 ChartForgeX.Terminal.TerminalTheme required
WithTiming(System.Double arg1, System.Double arg2, System.Double arg3) #

Sets automatic animation timing.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
WithTitle(System.String arg1) #

Sets the terminal title.

Parameters

arg1 System.String required
WithTypography(System.Double arg1, System.Double arg2) #

Sets terminal typography.

Parameters

arg1 System.Double required
arg2 System.Double required
WithWidth(System.Int32 arg1) #

Sets the logical SVG width.

Parameters

arg1 System.Int32 required
WithWindowStyle(ChartForgeX.Terminal.TerminalWindowStyle arg1) #

Sets the visible terminal window chrome independently of colors and command syntax.

Parameters

arg1 ChartForgeX.Terminal.TerminalWindowStyle required
WithWorkingDirectory(System.String arg1) #

Sets the working directory used by shell prompts.

Parameters

arg1 System.String required

Properties

Steps #

Gets the configured steps.

Tabs #

Gets the persistent terminal tabs in display order.

ActiveTabId #

Gets the tab that will be active when the completed story is shown.

Theme #

Gets the terminal theme.

WindowStyle #

Gets the visible terminal window chrome.

Title #

Gets the title-bar text.

WorkingDirectory #

Gets the working directory shown in prompts.

Dialect #

Gets the prompt dialect.

CustomPrompt #

Gets the explicit custom prompt, when configured.

Width #

Gets the logical SVG width.

FontSize #

Gets the terminal font size.

LineHeight #

Gets the terminal line height.

InitialDelaySeconds #

Gets the initial animation delay.

CharactersPerSecond #

Gets the simulated typing speed.

LineDelaySeconds #

Gets the delay between output lines.

TabHoldSeconds #

Gets the minimum time completed tab content remains visible before the next tab switch.

ShowFinalPrompt #

Gets whether a final prompt and cursor are shown.

PngOutputScale #

Gets the PNG output scale.