Skip to content
ChartForgeX

API Reference

Class

VisualStoryReplaySurface

Edit on GitHub
Namespace ChartForgeX.Stories
Assembly ChartForgeX.Stories
Source VisualStoryReplaySurface.cs:12
Base VisualStorySurface
Modifiers sealed

Shows sanitized recorded events on the scene clock in a bounded terminal viewport.

Inheritance

Constructors

public VisualStoryReplaySurface(StoryReplay replay, String? accessibleText = null, VisualStoryTerminalOptions? options = null, VisualTheme? theme = null, VisualThemeMode themeMode = Dark, TerminalStyleOptions? style = null) #
VisualStoryReplaySurface.cs:12

Creates a replay surface with optional accessibility heading, viewport and terminal palette. An omitted palette inherits the containing story theme.

Parameters

replay ChartForgeX.Stories.StoryReplay requiredposition: 0
accessibleText System.String? = null optionalposition: 1
options ChartForgeX.Stories.VisualStoryTerminalOptions? = null optionalposition: 2
theme ChartForgeX.Themes.VisualTheme? = null optionalposition: 3
themeMode ChartForgeX.Themes.VisualThemeMode = Dark optionalposition: 4
style ChartForgeX.Terminal.TerminalStyleOptions? = null optionalposition: 5

Properties

public StoryReplay Replay { get; } #
VisualStoryReplaySurface.cs:18

Gets the resolved replay, which does not execute commands.

public VisualStoryTerminalOptions Options { get; } #
VisualStoryReplaySurface.cs:20

Gets fixed viewport settings.

public VisualTheme? Theme { get; } #
VisualStoryReplaySurface.cs:22

Gets the explicit terminal palette, or null to inherit the containing story theme independently of its window chrome.

public VisualThemeMode ThemeMode { get; } #
VisualStoryReplaySurface.cs:24

Gets the explicit appearance for the optional replay theme.

public TerminalStyleOptions Style { get; } #
VisualStoryReplaySurface.cs:26

Gets local replay title-bar and cursor styling.

public override String AccessibleText { get; } #
VisualStoryReplaySurface.cs:28

Gets the complete sanitized replay transcript.