API Reference

Class

VisualStory

Namespace ChartForgeX.Stories

Assembly ChartForgeX.Stories

Modifiers sealed

Models a resolved, deterministic visual story. Execution and tokenization belong to optional adapters.

Inheritance

Object
VisualStory

Usage

Explore 39 API references to this type

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

Returned or exposed by 7

Accepted by parameters 32

Method HtmlVisualStoryRenderer.RenderFragment parameter story
Method HtmlVisualStoryRenderer.RenderPage parameter story
Method PngVisualStoryRenderer.Render parameter story
Method StoryArtifactExtensions.ToVisualArtifact parameter story
Method SvgVisualStoryRenderer.Render parameter story
Method SvgVisualStoryRenderer.RenderStatic parameter story
Extension method VisualStory.SaveApng parameter story
Extension method VisualStory.SaveGif parameter story
Extension method VisualStory.SavePng parameter story
Extension method VisualStory.SaveSvg parameter story
Extension method VisualStory.SaveTranscript parameter story
Extension method VisualStory.ToApng parameter story
Extension method VisualStory.ToGif parameter story
Extension method VisualStory.ToHtmlFragment parameter story
Extension method VisualStory.ToHtmlPage parameter story
Extension method VisualStory.ToPng parameter story
Extension method VisualStory.ToSvg parameter story
Extension method VisualStory.ToTranscript parameter story
Extension method VisualStory.ToVisualArtifact parameter story
Method VisualStoryExtensions.SaveApng parameter story
Method VisualStoryExtensions.SaveGif parameter story
Method VisualStoryExtensions.SavePng parameter story
Method VisualStoryExtensions.SaveSvg parameter story
Method VisualStoryExtensions.SaveTranscript parameter story
Method VisualStoryExtensions.ToApng parameter story
Method VisualStoryExtensions.ToGif parameter story
Method VisualStoryExtensions.ToHtmlFragment parameter story
Method VisualStoryExtensions.ToHtmlPage parameter story
Method VisualStoryExtensions.ToPng parameter story
Method VisualStoryExtensions.ToSvg parameter story
Method VisualStoryExtensions.ToTranscript parameter story
Method VisualStoryTranscriptRenderer.Render parameter story

Methods

public static VisualStory Create(String title) #

Returns: VisualStory

Creates a visual story.

Parameters

title System.String requiredposition: 0

public VisualStory Outcome(String id, String label, String completedPanelId) #

Returns: VisualStory

Declares an outcome that must be visible in the completed scene.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
completedPanelId System.String requiredposition: 2

public PreparedVisualStory Prepare(VisualStoryPlaybackOptions? playback = null) #

Returns: PreparedVisualStory

Captures a detached presentation for deterministic seeking and repeated exports.

Parameters

playback ChartForgeX.Stories.VisualStoryPlaybackOptions? = null optionalposition: 0

public VisualStoryScene Scene(String id, String title, Double durationSeconds = 2.5, VisualStorySceneLayout layout = Focus)

Returns: VisualStoryScene

Adds a scene and returns it for panel configuration.

Parameters

id System.String requiredposition: 0
title System.String requiredposition: 1
durationSeconds System.Double = 2.5 optionalposition: 2
layout ChartForgeX.Stories.VisualStorySceneLayout = Focus optionalposition: 3

public VisualStory WithDescription(String description) #

Returns: VisualStory

Sets the accessible story description.

Parameters

description System.String requiredposition: 0

public VisualStory WithFormat(VisualStoryFormat format, Int32 shortSide = 720) #

Returns: VisualStory

Sets a sharing format. Authoring stays in logical units; raster scale controls pixel density.

Parameters

format ChartForgeX.Stories.VisualStoryFormat requiredposition: 0
shortSide System.Int32 = 720 optionalposition: 1

public VisualStory WithPanelReflow(Boolean enabled = true) #

Returns: VisualStory

Enables portrait stacking for split scenes without changing explicit stacked layouts.

Parameters

enabled System.Boolean = true optionalposition: 0

public VisualStory WithSize(Int32 width, Int32 height) #

Returns: VisualStory

Sets logical output dimensions.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1

public VisualStory WithTheme(VisualStoryTheme theme) #

Returns: VisualStory

Sets the visual-story theme.

Parameters

theme ChartForgeX.Stories.VisualStoryTheme requiredposition: 0

Inherited Methods

Properties

public String Title { get; } #

Gets the story title.

public String Description { get; private set; } #

Gets the optional story description.

public Int32 Width { get; private set; } #

Gets the logical output width.

public Int32 Height { get; private set; } #

Gets the logical output height.

public Boolean ReflowPanels { get; private set; } #

Gets whether split panels stack in a portrait viewport.

public VisualStoryTheme Theme { get; private set; } #

Gets the output theme.

public IReadOnlyList<VisualStoryScene> Scenes { get; } #

Gets the ordered scenes.

public IReadOnlyList<VisualStoryOutcome> Outcomes { get; } #

Gets declared outcomes that must be visible in the completed scene.

Extension Methods

public static Void SaveApng(VisualStory story, String path, VisualStoryAnimationOptions? options = null) #

Returns: Void

Saves a visual story as animated PNG.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Stories.VisualStoryAnimationOptions? = null optionalposition: 2

public static Void SaveGif(VisualStory story, String path, VisualStoryAnimationOptions? options = null) #

Returns: Void

Saves a visual story as animated GIF.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Stories.VisualStoryAnimationOptions? = null optionalposition: 2

public static Void SavePng(VisualStory story, String path) #

Returns: Void

Saves the completed visual-story scene as PNG.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
path System.String requiredposition: 1

public static Void SaveSvg(VisualStory story, String path) #

Returns: Void

Saves a visual story as SVG.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
path System.String requiredposition: 1

public static Void SaveTranscript(VisualStory story, String path) #

Returns: Void

Saves a portable plain-text transcript.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
path System.String requiredposition: 1

public static Byte[] ToApng(VisualStory story, VisualStoryAnimationOptions? options = null) #

Returns: Byte[]

Renders a visual story to animated PNG.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
options ChartForgeX.Stories.VisualStoryAnimationOptions? = null optionalposition: 1

public static Byte[] ToGif(VisualStory story, VisualStoryAnimationOptions? options = null) #

Returns: Byte[]

Renders a visual story to animated GIF.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
options ChartForgeX.Stories.VisualStoryAnimationOptions? = null optionalposition: 1

public static String ToHtmlFragment(VisualStory story) #

Returns: String

Renders a visual story as an embeddable HTML fragment.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0

public static String ToHtmlPage(VisualStory story) #

Returns: String

Renders a visual story as a complete HTML document.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0

public static Byte[] ToPng(VisualStory story) #

Returns: Byte[]

Renders the completed visual-story scene to PNG.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0

ToSvg 2 overloads

public static String ToSvg(VisualStory story) #

Returns: String

Renders a visual story to self-contained animated SVG.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0

public static String ToSvg(VisualStory story, String idScope) #

Returns: String

Renders a visual story to self-contained animated SVG with a deterministic ID scope.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
idScope System.String requiredposition: 1

public static String ToTranscript(VisualStory story) #

Returns: String

Renders a portable plain-text transcript.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0

public static VisualArtifact ToVisualArtifact(VisualStory story, String? id = null, VisualArtifactSourceLanguage sourceLanguage = Native)

Returns: VisualArtifact

Captures the completed visual story while retaining story metadata and transcript accessibility.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
id System.String? = null optionalposition: 1
sourceLanguage ChartForgeX.VisualArtifacts.VisualArtifactSourceLanguage = Native optionalposition: 2