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

VisualStoryExtensions

Namespace ChartForgeX.Stories
Assembly ChartForgeX.Stories
Modifiers static

Exports visual story playback, completed images and portable transcripts.

Inheritance

  • Object
  • VisualStoryExtensions

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