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

ChartExtensions

Namespace ChartForgeX

Provides convenience rendering and file export methods for charts.

Inheritance

Object
ChartExtensions

Methods

AddChart 2 overloads

AddChart(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, ChartForgeX.Core.Chart arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Adds a rendered chart layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 ChartForgeX.Core.Chart required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddChart(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, ChartForgeX.Core.Chart arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Adds a rendered chart layer to a visual canvas using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 ChartForgeX.Core.Chart required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

AddChartGrid 2 overloads

AddChartGrid(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, ChartForgeX.Core.ChartGrid arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Adds a rendered chart grid layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 ChartForgeX.Core.ChartGrid required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddChartGrid(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, ChartForgeX.Core.ChartGrid arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Adds a rendered chart grid layer to a visual canvas using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 ChartForgeX.Core.ChartGrid required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

AddHeroBadgeImageFile 2 overloads

AddHeroBadgeImageFile(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, System.String arg6, System.String arg7, System.Nullable{ChartForgeX.Primitives.ChartColor} arg8, ChartForgeX.Composition.VisualCanvasImageFit arg9, System.Double arg10, System.Double arg11)

Decodes an image file and adds it as the content of a hero badge.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 System.String required
arg7 System.String required
arg8 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg9 ChartForgeX.Composition.VisualCanvasImageFit required
arg10 System.Double required
arg11 System.Double required

AddHeroBadgeImageFile(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, System.String arg5, System.String arg6, System.Nullable{ChartForgeX.Primitives.ChartColor} arg7, ChartForgeX.Composition.VisualCanvasImageFit arg8, System.Double arg9, System.Double arg10)

Decodes an image file and adds it as the content of a hero badge using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 System.String required
arg6 System.String required
arg7 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg8 ChartForgeX.Composition.VisualCanvasImageFit required
arg9 System.Double required
arg10 System.Double required

AddImageBytes 2 overloads

AddImageBytes(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, System.Byte[] arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Decodes image bytes and adds them as an image layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 System.Byte[] required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddImageBytes(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, System.Byte[] arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Decodes image bytes and adds them as an image layer using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 System.Byte[] required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

AddImageFile 2 overloads

AddImageFile(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, System.String arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Decodes an image file and adds it as an image layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 System.String required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddImageFile(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, System.String arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Decodes an image file and adds it as an image layer using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 System.String required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

AddRasterImage 2 overloads

AddRasterImage(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, ChartForgeX.Raster.RgbaImage arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Adds decoded RGBA pixels as an image layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 ChartForgeX.Raster.RgbaImage required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddRasterImage(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, ChartForgeX.Raster.RgbaImage arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Adds decoded RGBA pixels as an image layer using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 ChartForgeX.Raster.RgbaImage required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

AddTopology 2 overloads

AddTopology(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, ChartForgeX.Topology.TopologyChart arg6, ChartForgeX.Topology.TopologyRenderOptions arg7, ChartForgeX.Composition.VisualCanvasImageFit arg8, System.Double arg9)

Adds a rendered topology chart layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 ChartForgeX.Topology.TopologyChart required
arg7 ChartForgeX.Topology.TopologyRenderOptions required
arg8 ChartForgeX.Composition.VisualCanvasImageFit required
arg9 System.Double required

AddTopology(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, ChartForgeX.Topology.TopologyChart arg5, ChartForgeX.Topology.TopologyRenderOptions arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Adds a rendered topology chart layer to a visual canvas using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 ChartForgeX.Topology.TopologyChart required
arg6 ChartForgeX.Topology.TopologyRenderOptions required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddVisualBlock 2 overloads

AddVisualBlock(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, ChartForgeX.VisualBlocks.IVisualBlock arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Adds a rendered visual block layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 ChartForgeX.VisualBlocks.IVisualBlock required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddVisualBlock(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, ChartForgeX.VisualBlocks.IVisualBlock arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Adds a rendered visual block layer to a visual canvas using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 ChartForgeX.VisualBlocks.IVisualBlock required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

AddVisualGrid 2 overloads

AddVisualGrid(ChartForgeX.Composition.VisualCanvas arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Double arg5, ChartForgeX.VisualBlocks.VisualGrid arg6, ChartForgeX.Composition.VisualCanvasImageFit arg7, System.Double arg8)

Adds a rendered visual grid layer to a visual canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Double required
arg6 ChartForgeX.VisualBlocks.VisualGrid required
arg7 ChartForgeX.Composition.VisualCanvasImageFit required
arg8 System.Double required

AddVisualGrid(ChartForgeX.Composition.VisualCanvas arg1, ChartForgeX.Composition.VisualCanvasPlacement arg2, System.Double arg3, System.Double arg4, ChartForgeX.VisualBlocks.VisualGrid arg5, ChartForgeX.Composition.VisualCanvasImageFit arg6, System.Double arg7)

Adds a rendered visual grid layer to a visual canvas using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 ChartForgeX.Composition.VisualCanvasPlacement required
arg3 System.Double required
arg4 System.Double required
arg5 ChartForgeX.VisualBlocks.VisualGrid required
arg6 ChartForgeX.Composition.VisualCanvasImageFit required
arg7 System.Double required

GetPngFontInfo(ChartForgeX.Core.Chart chart) #

Resolves the font that would be used when rendering the chart to PNG.

Parameters

chart ChartForgeX.Core.Chart required: The chart to inspect.

Returns

The PNG font resolution details.

Save 5 overloads

Save(ChartForgeX.Core.Chart chart, System.String path, ChartForgeX.Core.RasterImageOptions rasterOptions) #

Saves a chart using the output path extension to choose SVG, HTML, PNG, or another raster image format.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Save(ChartForgeX.Core.ChartGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions rasterOptions) #

Saves a chart grid using the output path extension to choose SVG, HTML, PNG, or another raster image format.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Save(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path, ChartForgeX.Core.RasterImageOptions rasterOptions) #

Saves a visual block using the output path extension to choose SVG, HTML, PNG, or another raster image format.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Save(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions rasterOptions) #

Saves a visual grid using the output path extension to choose SVG, HTML, PNG, or another raster image format.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Save(ChartForgeX.Composition.VisualCanvas canvas, System.String path, ChartForgeX.Core.RasterImageOptions rasterOptions) #

Saves a visual canvas using the output path extension to choose SVG, HTML, PNG, or another raster image format.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
path System.String required: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveApng 2 overloads

SaveApng(ChartForgeX.Stories.VisualStory arg1, System.String arg2, ChartForgeX.Stories.VisualStoryAnimationOptions arg3) #

Saves a visual story as animated PNG.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 System.String required
arg3 ChartForgeX.Stories.VisualStoryAnimationOptions required

SaveApng(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2, ChartForgeX.Terminal.TerminalStoryAnimationOptions arg3)

Saves a terminal story as an animated PNG.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required
arg3 ChartForgeX.Terminal.TerminalStoryAnimationOptions required

SaveBmp 5 overloads

SaveBmp(ChartForgeX.Core.Chart chart, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart as a BMP file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveBmp(ChartForgeX.Core.ChartGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart grid as a BMP file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveBmp(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a visual block as a BMP file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveBmp(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a visual grid as a BMP file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveBmp(ChartForgeX.Composition.VisualCanvas arg1, System.String arg2, ChartForgeX.Core.RasterImageOptions arg3) #

Saves a visual canvas as a BMP file.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.String required
arg3 ChartForgeX.Core.RasterImageOptions required

SaveGif 2 overloads

SaveGif(ChartForgeX.Stories.VisualStory arg1, System.String arg2, ChartForgeX.Stories.VisualStoryAnimationOptions arg3) #

Saves a visual story as animated GIF.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 System.String required
arg3 ChartForgeX.Stories.VisualStoryAnimationOptions required

SaveGif(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2, ChartForgeX.Terminal.TerminalStoryAnimationOptions arg3)

Saves a terminal story as an animated GIF.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required
arg3 ChartForgeX.Terminal.TerminalStoryAnimationOptions required

SaveHtml 6 overloads

SaveHtml(ChartForgeX.Core.Chart chart, System.String path) #

Saves a chart as a complete HTML file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.

SaveHtml(ChartForgeX.Core.ChartGrid grid, System.String path) #

Saves a chart grid as a complete HTML file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.

SaveHtml(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path) #

Saves a visual block as a complete HTML file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.

SaveHtml(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path) #

Saves a visual grid as a complete HTML file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.

SaveHtml(ChartForgeX.Composition.VisualCanvas canvas, System.String path) #

Saves a visual canvas as a complete HTML file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
path System.String required: The output file path.

SaveHtml(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2) #

Saves a terminal story as a complete HTML document.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required

SavePng 7 overloads

SavePng(ChartForgeX.Core.Chart chart, System.String path) #

Saves a chart as a PNG file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.

SavePng(ChartForgeX.Core.ChartGrid grid, System.String path) #

Saves a chart grid as a PNG file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.

SavePng(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path) #

Saves a visual block as a PNG file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.

SavePng(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path) #

Saves a visual grid as a PNG file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.

SavePng(ChartForgeX.Composition.VisualCanvas canvas, System.String path) #

Saves a visual canvas as a PNG file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
path System.String required: The output file path.

SavePng(ChartForgeX.Stories.VisualStory arg1, System.String arg2) #

Saves the completed visual-story scene as PNG.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 System.String required

SavePng(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2) #

Saves the completed state of a terminal story as PNG.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required

SavePpm 5 overloads

SavePpm(ChartForgeX.Core.Chart chart, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart as a PPM file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SavePpm(ChartForgeX.Core.ChartGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart grid as a PPM file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SavePpm(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a visual block as a PPM file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SavePpm(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a visual grid as a PPM file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SavePpm(ChartForgeX.Composition.VisualCanvas arg1, System.String arg2, ChartForgeX.Core.RasterImageOptions arg3) #

Saves a visual canvas as a PPM file.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.String required
arg3 ChartForgeX.Core.RasterImageOptions required

SaveRasterImage 12 overloads

SaveRasterImage(ChartForgeX.Core.Chart chart, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Saves a chart as an opaque raster image file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Core.Chart chart, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart as an opaque raster image file using the output path extension to choose the format.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Core.ChartGrid grid, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Saves a chart grid as an opaque raster image file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Core.ChartGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart grid as an opaque raster image file using the output path extension to choose the format.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Saves a visual block as an opaque raster image file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path, ChartForgeX.Core.RasterImageOptions options)

Saves a visual block as an opaque raster image file using the output path extension to choose the format.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Saves a visual grid as an opaque raster image file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options)

Saves a visual grid as an opaque raster image file using the output path extension to choose the format.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Composition.VisualCanvas canvas, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Saves a visual canvas as an opaque raster image file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
path System.String required: The output file path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Composition.VisualCanvas canvas, System.String path, ChartForgeX.Core.RasterImageOptions options)

Saves a visual canvas as an opaque raster image file using the output path extension to choose the format.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Raster.RgbaImage image, System.String path, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Saves RGBA pixels to a dependency-free raster file.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.
path System.String required: The output file path.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveRasterImage(ChartForgeX.Raster.RgbaImage image, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves RGBA pixels to a raster file using the output path extension to choose the format.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveSvg 7 overloads

SaveSvg(ChartForgeX.Core.Chart chart, System.String path) #

Saves a chart as an SVG file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.

SaveSvg(ChartForgeX.Core.ChartGrid grid, System.String path) #

Saves a chart grid as an SVG file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.

SaveSvg(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path) #

Saves a visual block as an SVG file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.

SaveSvg(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path) #

Saves a visual grid as an SVG file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.

SaveSvg(ChartForgeX.Composition.VisualCanvas canvas, System.String path) #

Saves a visual canvas as an SVG file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
path System.String required: The output file path.

SaveSvg(ChartForgeX.Stories.VisualStory arg1, System.String arg2) #

Saves a visual story as SVG.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 System.String required

SaveSvg(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2) #

Saves a terminal story as SVG.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required

SaveTiff 5 overloads

SaveTiff(ChartForgeX.Core.Chart chart, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart as a TIFF file.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveTiff(ChartForgeX.Core.ChartGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a chart grid as a TIFF file.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveTiff(ChartForgeX.VisualBlocks.IVisualBlock block, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a visual block as a TIFF file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveTiff(ChartForgeX.VisualBlocks.VisualGrid grid, System.String path, ChartForgeX.Core.RasterImageOptions options) #

Saves a visual grid as a TIFF file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
path System.String required: The output file path.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

SaveTiff(ChartForgeX.Composition.VisualCanvas arg1, System.String arg2, ChartForgeX.Core.RasterImageOptions arg3) #

Saves a visual canvas as a TIFF file.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.String required
arg3 ChartForgeX.Core.RasterImageOptions required

SaveTranscript(ChartForgeX.Stories.VisualStory arg1, System.String arg2) #

Saves a portable plain-text transcript.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 System.String required

ToApng 2 overloads

ToApng(ChartForgeX.Stories.VisualStory arg1, ChartForgeX.Stories.VisualStoryAnimationOptions arg2) #

Renders a visual story to animated PNG.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 ChartForgeX.Stories.VisualStoryAnimationOptions required

ToApng(ChartForgeX.Terminal.TerminalStory arg1, ChartForgeX.Terminal.TerminalStoryAnimationOptions arg2) #

Renders a terminal story as an animated PNG.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 ChartForgeX.Terminal.TerminalStoryAnimationOptions required

ToBmp 5 overloads

ToBmp(ChartForgeX.Core.Chart chart, ChartForgeX.Core.RasterImageOptions options) #

Renders a chart to BMP bytes.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A BMP image.

ToBmp(ChartForgeX.Core.ChartGrid grid, ChartForgeX.Core.RasterImageOptions options) #

Renders a chart grid to BMP bytes.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A BMP image.

ToBmp(ChartForgeX.VisualBlocks.IVisualBlock block, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual block to BMP bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A BMP image.

ToBmp(ChartForgeX.VisualBlocks.VisualGrid grid, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual grid to BMP bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A BMP image.

ToBmp(ChartForgeX.Composition.VisualCanvas canvas, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual canvas to BMP bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A BMP image.

ToGif 3 overloads

ToGif(ChartForgeX.Raster.RgbaImage image) #

Encodes RGBA pixels to GIF bytes using an adaptive palette.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.

Returns

A GIF image.

ToGif(ChartForgeX.Stories.VisualStory arg1, ChartForgeX.Stories.VisualStoryAnimationOptions arg2) #

Renders a visual story to animated GIF.

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 ChartForgeX.Stories.VisualStoryAnimationOptions required

ToGif(ChartForgeX.Terminal.TerminalStory arg1, ChartForgeX.Terminal.TerminalStoryAnimationOptions arg2) #

Renders a terminal story as an animated GIF.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 ChartForgeX.Terminal.TerminalStoryAnimationOptions required

ToHtmlFragment 11 overloads

ToHtmlFragment(ChartForgeX.Core.Chart chart) #

Renders a chart to a standalone HTML fragment containing inline SVG.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.Core.Chart chart, System.String idScope) #

Renders a chart to an HTML fragment with an additional deterministic ID scope.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
idScope System.String required: A caller-provided scope used to keep IDs unique when embedding equivalent fragments together.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.Core.ChartGrid grid) #

Renders a chart grid to a standalone HTML fragment containing inline SVG charts.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.Core.ChartGrid grid, System.String idScope) #

Renders a chart grid to an HTML fragment with an additional deterministic ID scope.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
idScope System.String required: A caller-provided scope used to keep IDs unique when embedding equivalent fragments together.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.VisualBlocks.IVisualBlock block) #

Renders a visual block to a standalone HTML fragment containing inline SVG.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.VisualBlocks.IVisualBlock block, System.String idScope) #

Renders a visual block to an HTML fragment with an additional deterministic ID scope.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
idScope System.String required: A caller-provided scope used to keep IDs unique when embedding equivalent fragments together.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.VisualBlocks.VisualGrid grid) #

Renders a visual grid to a standalone HTML fragment containing inline SVG charts and visual blocks.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.VisualBlocks.VisualGrid grid, System.String idScope) #

Renders a visual grid to an HTML fragment with an additional deterministic ID scope.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
idScope System.String required: A caller-provided scope used to keep IDs unique when embedding equivalent fragments together.

Returns

An HTML fragment.

ToHtmlFragment(ChartForgeX.Stories.VisualStory arg1) #

Renders a visual story as an embeddable HTML fragment.

Parameters

arg1 ChartForgeX.Stories.VisualStory required

ToHtmlFragment(ChartForgeX.Terminal.TerminalStory arg1) #

Renders a terminal story as an embeddable HTML fragment.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required

ToHtmlFragment(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2) #

Renders a terminal story as an embeddable HTML fragment with a deterministic ID scope.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required

ToHtmlPage 7 overloads

ToHtmlPage(ChartForgeX.Core.Chart chart) #

Renders a chart to a complete HTML document.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.

Returns

An HTML page.

ToHtmlPage(ChartForgeX.Core.ChartGrid grid) #

Renders a chart grid to a complete HTML document.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.

Returns

An HTML page.

ToHtmlPage(ChartForgeX.VisualBlocks.IVisualBlock block) #

Renders a visual block to a complete HTML document.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.

Returns

An HTML page.

ToHtmlPage(ChartForgeX.VisualBlocks.VisualGrid grid) #

Renders a visual grid to a complete HTML document.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.

Returns

An HTML page.

ToHtmlPage(ChartForgeX.Composition.VisualCanvas canvas) #

Renders a visual canvas to a complete HTML document.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.

Returns

An HTML page.

ToHtmlPage(ChartForgeX.Stories.VisualStory arg1) #

Renders a visual story as a complete HTML document.

Parameters

arg1 ChartForgeX.Stories.VisualStory required

ToHtmlPage(ChartForgeX.Terminal.TerminalStory arg1) #

Renders a terminal story as a complete HTML document.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required

ToJpeg(ChartForgeX.Raster.RgbaImage image, ChartForgeX.Core.RasterImageOptions options) #

Encodes RGBA pixels to JPEG bytes after flattening transparent pixels against the configured background.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A JPEG image.

ToPng 9 overloads

ToPng(ChartForgeX.Core.Chart chart) #

Renders a chart to PNG bytes.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.

Returns

A PNG image.

ToPng(ChartForgeX.Core.ChartGrid grid) #

Renders a chart grid to PNG bytes.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.

Returns

A PNG image.

ToPng(ChartForgeX.VisualBlocks.IVisualBlock block) #

Renders a visual block to PNG bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.

Returns

A PNG image.

ToPng(ChartForgeX.VisualBlocks.VisualGrid grid) #

Renders a visual grid to PNG bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.

Returns

A PNG image.

ToPng(ChartForgeX.Composition.VisualCanvas canvas) #

Renders a visual canvas to PNG bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.

Returns

A PNG image.

ToPng(ChartForgeX.Raster.RgbaImage image) #

Encodes RGBA pixels to PNG bytes.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.

Returns

A PNG image.

ToPng(ChartForgeX.Raster.RgbaImage arg1, ChartForgeX.Core.RasterImageOptions arg2) #

Encodes an RGBA image as PNG bytes using dependency-free raster options.

Parameters

arg1 ChartForgeX.Raster.RgbaImage required
arg2 ChartForgeX.Core.RasterImageOptions required

ToPng(ChartForgeX.Stories.VisualStory arg1) #

Renders the completed visual-story scene to PNG.

Parameters

arg1 ChartForgeX.Stories.VisualStory required

ToPng(ChartForgeX.Terminal.TerminalStory arg1) #

Renders the completed state of a terminal story to PNG bytes.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required

ToPpm 5 overloads

ToPpm(ChartForgeX.Core.Chart chart, ChartForgeX.Core.RasterImageOptions options) #

Renders a chart to PPM bytes.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A PPM image.

ToPpm(ChartForgeX.Core.ChartGrid grid, ChartForgeX.Core.RasterImageOptions options) #

Renders a chart grid to PPM bytes.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A PPM image.

ToPpm(ChartForgeX.VisualBlocks.IVisualBlock block, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual block to PPM bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A PPM image.

ToPpm(ChartForgeX.VisualBlocks.VisualGrid grid, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual grid to PPM bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A PPM image.

ToPpm(ChartForgeX.Composition.VisualCanvas canvas, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual canvas to PPM bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A PPM image.

ToRasterImage 6 overloads

ToRasterImage(ChartForgeX.Core.Chart chart, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Renders a chart to opaque raster image bytes.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRasterImage(ChartForgeX.Core.ChartGrid grid, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Renders a chart grid to opaque raster image bytes.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRasterImage(ChartForgeX.VisualBlocks.IVisualBlock block, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Renders a visual block to opaque raster image bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRasterImage(ChartForgeX.VisualBlocks.VisualGrid grid, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Renders a visual grid to opaque raster image bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRasterImage(ChartForgeX.Composition.VisualCanvas canvas, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Renders a visual canvas to opaque raster image bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRasterImage(ChartForgeX.Raster.RgbaImage image, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Encodes RGBA pixels to a dependency-free raster format.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

Encoded raster image bytes.

ToRgbaImage 5 overloads

ToRgbaImage(ChartForgeX.Core.Chart chart) #

Renders a chart directly to an in-memory RGBA image without encoding it.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.

Returns

The rendered RGBA image.

ToRgbaImage(ChartForgeX.Core.ChartGrid grid) #

Renders a chart grid directly to an in-memory RGBA image without encoding it.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.

Returns

The rendered RGBA image.

ToRgbaImage(ChartForgeX.VisualBlocks.IVisualBlock block) #

Renders a visual block directly to an in-memory RGBA image without encoding it.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.

Returns

The rendered RGBA image.

ToRgbaImage(ChartForgeX.VisualBlocks.VisualGrid grid) #

Renders a visual grid directly to an in-memory RGBA image without encoding it.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.

Returns

The rendered RGBA image.

ToRgbaImage(ChartForgeX.Composition.VisualCanvas canvas) #

Renders a visual canvas directly to an in-memory RGBA image without encoding it.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.

Returns

The rendered RGBA image.

ToSvg 14 overloads

ToSvg(ChartForgeX.Core.Chart chart) #

Renders a chart to SVG markup.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.

Returns

SVG markup.

ToSvg(ChartForgeX.Core.Chart chart, System.String idScope) #

Renders a chart to SVG markup with an additional deterministic ID scope.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
idScope System.String required: A caller-provided scope used to keep SVG element IDs unique when embedding multiple SVGs in one document.

Returns

SVG markup.

ToSvg(ChartForgeX.Core.ChartGrid grid) #

Renders a chart grid to SVG markup.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.

Returns

SVG markup.

ToSvg(ChartForgeX.Core.ChartGrid grid, System.String idScope) #

Renders a chart grid to SVG markup with an additional deterministic ID scope.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
idScope System.String required: A caller-provided scope used to keep SVG element IDs unique when embedding multiple SVG grids in one document.

Returns

SVG markup.

ToSvg(ChartForgeX.VisualBlocks.IVisualBlock block) #

Renders a visual block to SVG markup.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.

Returns

SVG markup.

ToSvg(ChartForgeX.VisualBlocks.IVisualBlock block, System.String idScope) #

Renders a visual block to SVG markup with an additional deterministic ID scope.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
idScope System.String required: A caller-provided scope used to keep SVG element IDs unique when embedding multiple SVGs in one document.

Returns

SVG markup.

ToSvg(ChartForgeX.VisualBlocks.VisualGrid grid) #

Renders a visual grid to SVG markup.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.

Returns

SVG markup.

ToSvg(ChartForgeX.VisualBlocks.VisualGrid grid, System.String idScope) #

Renders a visual grid to SVG markup with an additional deterministic ID scope.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
idScope System.String required: A caller-provided scope used to keep SVG element IDs unique when embedding multiple SVG grids in one document.

Returns

SVG markup.

ToSvg(ChartForgeX.Composition.VisualCanvas canvas) #

Renders a visual canvas to SVG markup.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.

Returns

SVG markup.

ToSvg(ChartForgeX.Composition.VisualCanvas canvas, System.String idScope) #

Renders a visual canvas to SVG markup with an additional deterministic ID scope.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
idScope System.String required: A caller-provided scope used to keep SVG element IDs unique when embedding multiple SVGs in one document.

Returns

SVG markup.

ToSvg(ChartForgeX.Stories.VisualStory arg1) #

Renders a visual story to self-contained animated SVG.

Parameters

arg1 ChartForgeX.Stories.VisualStory required

ToSvg(ChartForgeX.Stories.VisualStory arg1, System.String arg2) #

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

Parameters

arg1 ChartForgeX.Stories.VisualStory required
arg2 System.String required

ToSvg(ChartForgeX.Terminal.TerminalStory arg1) #

Renders a terminal story to SVG markup.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required

ToSvg(ChartForgeX.Terminal.TerminalStory arg1, System.String arg2) #

Renders a terminal story to SVG markup with a deterministic ID scope.

Parameters

arg1 ChartForgeX.Terminal.TerminalStory required
arg2 System.String required

ToTiff 5 overloads

ToTiff(ChartForgeX.Core.Chart chart, ChartForgeX.Core.RasterImageOptions options) #

Renders a chart to TIFF bytes.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A TIFF image.

ToTiff(ChartForgeX.Core.ChartGrid grid, ChartForgeX.Core.RasterImageOptions options) #

Renders a chart grid to TIFF bytes.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A TIFF image.

ToTiff(ChartForgeX.VisualBlocks.IVisualBlock block, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual block to TIFF bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A TIFF image.

ToTiff(ChartForgeX.VisualBlocks.VisualGrid grid, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual grid to TIFF bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A TIFF image.

ToTiff(ChartForgeX.Composition.VisualCanvas canvas, ChartForgeX.Core.RasterImageOptions options) #

Renders a visual canvas to TIFF bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

Returns

A TIFF image.

ToTranscript(ChartForgeX.Stories.VisualStory arg1) #

Renders a portable plain-text transcript.

Parameters

arg1 ChartForgeX.Stories.VisualStory required

ToVisualCanvas(ChartForgeX.Raster.RgbaImage arg1, ChartForgeX.Composition.VisualCanvasImageFit arg2) #

Creates a visual canvas from decoded RGBA pixels with the image as the first layer.

Parameters

arg1 ChartForgeX.Raster.RgbaImage required
arg2 ChartForgeX.Composition.VisualCanvasImageFit required

WithBrandKit 2 overloads

WithBrandKit(ChartForgeX.Core.Chart chart, ChartForgeX.Themes.ChartBrandKit brandKit) #

Applies a reusable brand kit to the current chart theme.

Parameters

chart ChartForgeX.Core.Chart required: The chart to configure.
brandKit ChartForgeX.Themes.ChartBrandKit required: The brand kit to apply.

Returns

The current chart.

WithBrandKit(ChartForgeX.Core.ChartGrid grid, ChartForgeX.Themes.ChartBrandKit brandKit) #

Applies a reusable brand kit to the current chart grid theme, creating a light grid theme when the grid is currently automatic.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to configure.
brandKit ChartForgeX.Themes.ChartBrandKit required: The brand kit to apply.

Returns

The current chart grid.

WithBrandKit``1(``0 block, ChartForgeX.Themes.ChartBrandKit brandKit) #

Applies a reusable brand kit to the current visual block theme.

Type Parameters

TBlock: The visual block type.

Parameters

block ``0 required: The visual block to configure.
brandKit ChartForgeX.Themes.ChartBrandKit required: The brand kit to apply.

Returns

The current visual block.

WithPalette 2 overloads

WithPalette(ChartForgeX.Core.Chart chart, ChartForgeX.Primitives.ChartColor[] colors) #

Sets the default series palette on the current chart theme.

Parameters

chart ChartForgeX.Core.Chart required: The chart to configure.
colors ChartForgeX.Primitives.ChartColor[] required: The palette colors.

Returns

The current chart.

WithPalette(ChartForgeX.Core.Chart chart, System.String[] colors) #

Sets the default series palette on the current chart theme from hexadecimal color strings.

Parameters

chart ChartForgeX.Core.Chart required: The chart to configure.
colors System.String[] required: The color strings in #RGB, #RGBA, #RRGGBB, or #RRGGBBAA notation.

Returns

The current chart.

WithPalette``1 2 overloads

WithPalette``1(``0 block, ChartForgeX.Primitives.ChartColor[] colors) #

Sets the default palette on the current visual block theme.

Type Parameters

TBlock: The visual block type.

Parameters

block ``0 required: The visual block to configure.
colors ChartForgeX.Primitives.ChartColor[] required: The palette colors.

Returns

The current visual block.

WithPalette``1(``0 block, System.String[] colors) #

Sets the default palette on the current visual block theme from hexadecimal color strings.

Type Parameters

TBlock: The visual block type.

Parameters

block ``0 required: The visual block to configure.
colors System.String[] required: The color strings in #RGB, #RGBA, #RRGGBB, or #RRGGBBAA notation.

Returns

The current visual block.

WithPngOutputScale(ChartForgeX.VisualBlocks.VisualGrid grid, ChartForgeX.Core.ChartPngOutputScale scale) #

Sets the output pixel multiplier used by visual grid PNG exports using a named density preset.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to configure.
scale ChartForgeX.Core.ChartPngOutputScale required: The output density preset.

Returns

The current visual grid.

WithPngOutputScale``1(``0 block, ChartForgeX.Core.ChartPngOutputScale scale) #

Sets the output pixel multiplier used by visual block PNG exports using a named density preset.

Type Parameters

TBlock: The visual block type.

Parameters

block ``0 required: The visual block to configure.
scale ChartForgeX.Core.ChartPngOutputScale required: The output density preset.

Returns

The current visual block.

WithTheme 3 overloads

WithTheme(ChartForgeX.Core.Chart chart, System.Action{ChartForgeX.Themes.ChartTheme} configure) #

Configures the current chart theme in place.

Parameters

chart ChartForgeX.Core.Chart required: The chart to configure.
configure System.Action{ChartForgeX.Themes.ChartTheme} required: The theme customization callback.

Returns

The current chart.

WithTheme(ChartForgeX.Core.ChartGrid grid, System.Action{ChartForgeX.Themes.ChartTheme} configure) #

Configures the current chart grid theme in place, creating a light grid theme when the grid is currently automatic.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to configure.
configure System.Action{ChartForgeX.Themes.ChartTheme} required: The theme customization callback.

Returns

The current chart grid.

WithTheme(ChartForgeX.VisualBlocks.VisualGrid grid, System.Action{ChartForgeX.Themes.ChartTheme} configure) #

Configures the current visual grid theme in place, creating a light theme when the grid is currently automatic.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to configure.
configure System.Action{ChartForgeX.Themes.ChartTheme} required: The theme customization callback.

Returns

The current visual grid.

WriteBmp 5 overloads

WriteBmp(ChartForgeX.Core.Chart chart, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a chart to a BMP stream.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteBmp(ChartForgeX.Core.ChartGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a chart grid to a BMP stream.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteBmp(ChartForgeX.VisualBlocks.IVisualBlock block, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options)

Writes a visual block to a BMP stream.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteBmp(ChartForgeX.VisualBlocks.VisualGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a visual grid to a BMP stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteBmp(ChartForgeX.Composition.VisualCanvas arg1, System.IO.Stream arg2, ChartForgeX.Core.RasterImageOptions arg3) #

Writes a visual canvas to a BMP stream.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.IO.Stream required
arg3 ChartForgeX.Core.RasterImageOptions required

WritePpm 5 overloads

WritePpm(ChartForgeX.Core.Chart chart, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a chart to a PPM stream.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WritePpm(ChartForgeX.Core.ChartGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a chart grid to a PPM stream.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WritePpm(ChartForgeX.VisualBlocks.IVisualBlock block, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options)

Writes a visual block to a PPM stream.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WritePpm(ChartForgeX.VisualBlocks.VisualGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a visual grid to a PPM stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WritePpm(ChartForgeX.Composition.VisualCanvas arg1, System.IO.Stream arg2, ChartForgeX.Core.RasterImageOptions arg3) #

Writes a visual canvas to a PPM stream.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.IO.Stream required
arg3 ChartForgeX.Core.RasterImageOptions required

WriteRasterImage 6 overloads

WriteRasterImage(ChartForgeX.Core.Chart chart, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Writes a chart to an opaque raster image stream.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteRasterImage(ChartForgeX.Core.ChartGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Writes a chart grid to an opaque raster image stream.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteRasterImage(ChartForgeX.VisualBlocks.IVisualBlock block, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Writes a visual block to an opaque raster image stream.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteRasterImage(ChartForgeX.VisualBlocks.VisualGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Writes a visual grid to an opaque raster image stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteRasterImage(ChartForgeX.Composition.VisualCanvas canvas, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Writes a visual canvas to an opaque raster image stream.

Parameters

canvas ChartForgeX.Composition.VisualCanvas required: The visual canvas to render.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteRasterImage(ChartForgeX.Raster.RgbaImage image, System.IO.Stream stream, ChartForgeX.Core.RasterImageFormat format, ChartForgeX.Core.RasterImageOptions options)

Writes RGBA pixels to a dependency-free raster stream.

Parameters

image ChartForgeX.Raster.RgbaImage required: The image to encode.
stream System.IO.Stream required: The destination stream.
format ChartForgeX.Core.RasterImageFormat required: The raster image format.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteTiff 5 overloads

WriteTiff(ChartForgeX.Core.Chart chart, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a chart to a TIFF stream.

Parameters

chart ChartForgeX.Core.Chart required: The chart to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteTiff(ChartForgeX.Core.ChartGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options) #

Writes a chart grid to a TIFF stream.

Parameters

grid ChartForgeX.Core.ChartGrid required: The chart grid to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteTiff(ChartForgeX.VisualBlocks.IVisualBlock block, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options)

Writes a visual block to a TIFF stream.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock required: The visual block to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteTiff(ChartForgeX.VisualBlocks.VisualGrid grid, System.IO.Stream stream, ChartForgeX.Core.RasterImageOptions options)

Writes a visual grid to a TIFF stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid required: The visual grid to render.
stream System.IO.Stream required: The destination stream.
options ChartForgeX.Core.RasterImageOptions required: Optional raster export options.

WriteTiff(ChartForgeX.Composition.VisualCanvas arg1, System.IO.Stream arg2, ChartForgeX.Core.RasterImageOptions arg3) #

Writes a visual canvas to a TIFF stream.

Parameters

arg1 ChartForgeX.Composition.VisualCanvas required
arg2 System.IO.Stream required
arg3 ChartForgeX.Core.RasterImageOptions required