Skip to content
ChartForgeX

API Reference

Class

VisualStoryExtensions

Edit on GitHub
Namespace ChartForgeX.Stories
Assembly ChartForgeX.Stories
Source VisualStoryExtensions.cs:11
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) #
VisualStoryExtensions.cs:56
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) #
VisualStoryExtensions.cs:50
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) #
VisualStoryExtensions.cs:44
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) #
VisualStoryExtensions.cs:38
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) #
VisualStoryExtensions.cs:62
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) #
VisualStoryExtensions.cs:31
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) #
VisualStoryExtensions.cs:27
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) #
VisualStoryExtensions.cs:17
Returns: String

Renders a visual story as an embeddable HTML fragment.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
public static String ToHtmlPage(VisualStory story) #
VisualStoryExtensions.cs:20
Returns: String

Renders a visual story as a complete HTML document.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0
public static Byte[] ToPng(VisualStory story) #
VisualStoryExtensions.cs:23
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) #
VisualStoryExtensions.cs:11
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) #
VisualStoryExtensions.cs:14
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) #
VisualStoryExtensions.cs:34
Returns: String

Renders a portable plain-text transcript.

Parameters

story ChartForgeX.Stories.VisualStory requiredposition: 0