API Reference

Class

VisualsExtensions

Namespace ChartForgeX

Assembly ChartForgeX.Visuals

Modifiers static

Provides static canvas and composition-grid export and embedding methods.

Inheritance

Object
VisualsExtensions

Methods

AddChart 2 overloads

public static VisualCanvas AddChart(VisualCanvas canvas, Double x, Double y, Double width, Double height, Chart chart, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

Adds a rendered chart layer to a visual canvas.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
chart ChartForgeX.Core.Chart requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7

public static VisualCanvas AddChart(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, Chart chart, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
chart ChartForgeX.Core.Chart requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6

AddChartGrid 2 overloads

public static VisualCanvas AddChartGrid(VisualCanvas canvas, Double x, Double y, Double width, Double height, ChartGrid grid, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

Adds a rendered chart grid layer to a visual canvas.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
grid ChartForgeX.Core.ChartGrid requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7

public static VisualCanvas AddChartGrid(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, ChartGrid grid, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
grid ChartForgeX.Core.ChartGrid requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6

AddHeroBadgeImageFile 2 overloads

public static VisualCanvas AddHeroBadgeImageFile(VisualCanvas canvas, Double x, Double y, Double width, Double height, String path, String symbol = "", ChartColor? accent = null, VisualCanvasImageFit fit = Contain, Double padding = 10, Double opacity = 1, RasterDecodeOptions? options = null)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
path System.String requiredposition: 5
symbol System.String = "" optionalposition: 6
accent ChartForgeX.Primitives.ChartColor? = null optionalposition: 7
fit ChartForgeX.Composition.VisualCanvasImageFit = Contain optionalposition: 8
padding System.Double = 10 optionalposition: 9
opacity System.Double = 1 optionalposition: 10
options ChartForgeX.Raster.RasterDecodeOptions? = null optionalposition: 11

public static VisualCanvas AddHeroBadgeImageFile(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, String path, String symbol = "", ChartColor? accent = null, VisualCanvasImageFit fit = Contain, Double padding = 10, Double opacity = 1, RasterDecodeOptions? options = null)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
path System.String requiredposition: 4
symbol System.String = "" optionalposition: 5
accent ChartForgeX.Primitives.ChartColor? = null optionalposition: 6
fit ChartForgeX.Composition.VisualCanvasImageFit = Contain optionalposition: 7
padding System.Double = 10 optionalposition: 8
opacity System.Double = 1 optionalposition: 9
options ChartForgeX.Raster.RasterDecodeOptions? = null optionalposition: 10

AddImageBytes 2 overloads

public static VisualCanvas AddImageBytes(VisualCanvas canvas, Double x, Double y, Double width, Double height, Byte[] data, VisualCanvasImageFit fit = Stretch, Double opacity = 1, RasterDecodeOptions? options = null)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
data System.Byte[] requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7
options ChartForgeX.Raster.RasterDecodeOptions? = null optionalposition: 8

public static VisualCanvas AddImageBytes(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, Byte[] data, VisualCanvasImageFit fit = Stretch, Double opacity = 1, RasterDecodeOptions? options = null)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
data System.Byte[] requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6
options ChartForgeX.Raster.RasterDecodeOptions? = null optionalposition: 7

AddImageFile 2 overloads

public static VisualCanvas AddImageFile(VisualCanvas canvas, Double x, Double y, Double width, Double height, String path, VisualCanvasImageFit fit = Stretch, Double opacity = 1, RasterDecodeOptions? options = null)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
path System.String requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7
options ChartForgeX.Raster.RasterDecodeOptions? = null optionalposition: 8

public static VisualCanvas AddImageFile(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, String path, VisualCanvasImageFit fit = Stretch, Double opacity = 1, RasterDecodeOptions? options = null)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
path System.String requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6
options ChartForgeX.Raster.RasterDecodeOptions? = null optionalposition: 7

AddRasterImage 2 overloads

public static VisualCanvas AddRasterImage(VisualCanvas canvas, Double x, Double y, Double width, Double height, RgbaImage image, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
image ChartForgeX.Raster.RgbaImage requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7

public static VisualCanvas AddRasterImage(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, RgbaImage image, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
image ChartForgeX.Raster.RgbaImage requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6

AddTopology 2 overloads

public static VisualCanvas AddTopology(VisualCanvas canvas, Double x, Double y, Double width, Double height, TopologyChart topology, TopologyRenderOptions? options = null, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

Adds a rendered topology chart layer to a visual canvas.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
topology ChartForgeX.Topology.TopologyChart requiredposition: 5
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 6
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 7
opacity System.Double = 1 optionalposition: 8

public static VisualCanvas AddTopology(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, TopologyChart topology, TopologyRenderOptions? options = null, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
topology ChartForgeX.Topology.TopologyChart requiredposition: 4
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7

AddVisualBlock 2 overloads

public static VisualCanvas AddVisualBlock(VisualCanvas canvas, Double x, Double y, Double width, Double height, IVisualBlock block, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

Adds a rendered visual block layer to a visual canvas.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7

public static VisualCanvas AddVisualBlock(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, IVisualBlock block, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6

AddVisualGrid 2 overloads

public static VisualCanvas AddVisualGrid(VisualCanvas canvas, Double x, Double y, Double width, Double height, VisualGrid grid, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

Adds a rendered visual grid layer to a visual canvas.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 5
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 6
opacity System.Double = 1 optionalposition: 7

public static VisualCanvas AddVisualGrid(VisualCanvas canvas, VisualCanvasPlacement placement, Double width, Double height, VisualGrid grid, VisualCanvasImageFit fit = Stretch, Double opacity = 1)

Returns: VisualCanvas

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
placement ChartForgeX.Composition.VisualCanvasPlacement requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 4
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 5
opacity System.Double = 1 optionalposition: 6

public static VisualGrid ConfigureTheme(VisualGrid grid, Action<ChartTheme> configure) #

Returns: VisualGrid

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

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to configure.
configure System.Action<ChartForgeX.Themes.ChartTheme> requiredposition: 1: The theme customization callback.

Returns

The current visual grid.

Save 2 overloads

public static Void Save(VisualGrid grid, String path, RasterImageOptions? rasterOptions = null) #

Returns: Void

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

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void Save(VisualCanvas canvas, String path, RasterImageOptions? rasterOptions = null) #

Returns: Void

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
path System.String requiredposition: 1: The output file path.
rasterOptions ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

SaveBmp 2 overloads

public static Void SaveBmp(VisualGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual grid as a BMP file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void SaveBmp(VisualCanvas canvas, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual canvas as a BMP file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2

SaveHtml 2 overloads

public static Void SaveHtml(VisualGrid grid, String path) #

Returns: Void

Saves a visual grid as a complete HTML file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.

public static Void SaveHtml(VisualCanvas canvas, String path) #

Returns: Void

Saves a visual canvas as a complete HTML file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
path System.String requiredposition: 1: The output file path.

SavePng 2 overloads

public static Void SavePng(VisualGrid grid, String path) #

Returns: Void

Saves a visual grid as a PNG file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.

public static Void SavePng(VisualCanvas canvas, String path) #

Returns: Void

Saves a visual canvas as a PNG file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
path System.String requiredposition: 1: The output file path.

SavePpm 2 overloads

public static Void SavePpm(VisualGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual grid as a PPM file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void SavePpm(VisualCanvas canvas, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual canvas as a PPM file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2

SaveRasterImage 4 overloads

public static Void SaveRasterImage(VisualGrid grid, String path, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Saves a visual grid as an opaque raster image file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.
format ChartForgeX.Core.RasterImageFormat requiredposition: 2: The raster image format.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3: Optional raster export options.

public static Void SaveRasterImage(VisualGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

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

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void SaveRasterImage(VisualCanvas canvas, String path, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Saves a visual canvas as an opaque raster image file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
path System.String requiredposition: 1: The output file path.
format ChartForgeX.Core.RasterImageFormat requiredposition: 2: The raster image format.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3: Optional raster export options.

public static Void SaveRasterImage(VisualCanvas canvas, String path, RasterImageOptions? options = null) #

Returns: Void

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
path System.String requiredposition: 1: The output file path.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

SaveSvg 2 overloads

public static Void SaveSvg(VisualGrid grid, String path) #

Returns: Void

Saves a visual grid as an SVG file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.

public static Void SaveSvg(VisualCanvas canvas, String path) #

Returns: Void

Saves a visual canvas as an SVG file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
path System.String requiredposition: 1: The output file path.

SaveTiff 2 overloads

public static Void SaveTiff(VisualGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual grid as a TIFF file.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
path System.String requiredposition: 1: The output file path.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void SaveTiff(VisualCanvas canvas, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual canvas as a TIFF file.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2

ToBmp 2 overloads

public static Byte[] ToBmp(VisualGrid grid, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual grid to BMP bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A BMP image.

public static Byte[] ToBmp(VisualCanvas canvas, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual canvas to BMP bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A BMP image.

ToHtmlFragment 2 overloads

public static String ToHtmlFragment(VisualGrid grid) #

Returns: String

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

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.

Returns

An HTML fragment.

public static String ToHtmlFragment(VisualGrid grid, String idScope) #

Returns: String

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

Parameters

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

Returns

An HTML fragment.

ToHtmlPage 2 overloads

public static String ToHtmlPage(VisualGrid grid) #

Returns: String

Renders a visual grid to a complete HTML document.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.

Returns

An HTML page.

public static String ToHtmlPage(VisualCanvas canvas) #

Returns: String

Renders a visual canvas to a complete HTML document.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.

Returns

An HTML page.

ToPng 2 overloads

public static Byte[] ToPng(VisualGrid grid) #

Returns: Byte[]

Renders a visual grid to PNG bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.

Returns

A PNG image.

public static Byte[] ToPng(VisualCanvas canvas) #

Returns: Byte[]

Renders a visual canvas to PNG bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.

Returns

A PNG image.

ToPpm 2 overloads

public static Byte[] ToPpm(VisualGrid grid, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual grid to PPM bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A PPM image.

public static Byte[] ToPpm(VisualCanvas canvas, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual canvas to PPM bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A PPM image.

ToRasterImage 2 overloads

public static Byte[] ToRasterImage(VisualGrid grid, RasterImageFormat format, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual grid to opaque raster image bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
format ChartForgeX.Core.RasterImageFormat requiredposition: 1: The raster image format.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

Returns

Encoded raster image bytes.

public static Byte[] ToRasterImage(VisualCanvas canvas, RasterImageFormat format, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual canvas to opaque raster image bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
format ChartForgeX.Core.RasterImageFormat requiredposition: 1: The raster image format.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

Returns

Encoded raster image bytes.

ToRgbaImage 2 overloads

public static RgbaImage ToRgbaImage(VisualGrid grid) #

Returns: RgbaImage

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

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.

Returns

The rendered RGBA image.

public static RgbaImage ToRgbaImage(VisualCanvas canvas) #

Returns: RgbaImage

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

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.

Returns

The rendered RGBA image.

ToSvg 4 overloads

public static String ToSvg(VisualGrid grid) #

Returns: String

Renders a visual grid to SVG markup.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.

Returns

SVG markup.

public static String ToSvg(VisualGrid grid, String idScope) #

Returns: String

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

Parameters

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

Returns

SVG markup.

public static String ToSvg(VisualCanvas canvas) #

Returns: String

Renders a visual canvas to SVG markup.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.

Returns

SVG markup.

public static String ToSvg(VisualCanvas canvas, String idScope) #

Returns: String

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

Parameters

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

Returns

SVG markup.

ToTiff 2 overloads

public static Byte[] ToTiff(VisualGrid grid, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual grid to TIFF bytes.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A TIFF image.

public static Byte[] ToTiff(VisualCanvas canvas, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual canvas to TIFF bytes.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A TIFF image.

public static VisualCanvas ToVisualCanvas(RgbaImage image, VisualCanvasImageFit fit = Stretch) #

Returns: VisualCanvas

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

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0
fit ChartForgeX.Composition.VisualCanvasImageFit = Stretch optionalposition: 1

public static VisualGrid WithPngOutputScale(VisualGrid grid, ChartPngOutputScale scale) #

Returns: VisualGrid

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

Parameters

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

Returns

The current visual grid.

WriteBmp 2 overloads

public static Void WriteBmp(VisualGrid grid, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual grid to a BMP stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
stream System.IO.Stream requiredposition: 1: The destination stream.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void WriteBmp(VisualCanvas canvas, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual canvas to a BMP stream.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
stream System.IO.Stream requiredposition: 1
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2

WritePpm 2 overloads

public static Void WritePpm(VisualGrid grid, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual grid to a PPM stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
stream System.IO.Stream requiredposition: 1: The destination stream.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void WritePpm(VisualCanvas canvas, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual canvas to a PPM stream.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
stream System.IO.Stream requiredposition: 1
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2

WriteRasterImage 2 overloads

public static Void WriteRasterImage(VisualGrid grid, Stream stream, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Writes a visual grid to an opaque raster image stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
stream System.IO.Stream requiredposition: 1: The destination stream.
format ChartForgeX.Core.RasterImageFormat requiredposition: 2: The raster image format.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3: Optional raster export options.

public static Void WriteRasterImage(VisualCanvas canvas, Stream stream, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Writes a visual canvas to an opaque raster image stream.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0: The visual canvas to render.
stream System.IO.Stream requiredposition: 1: The destination stream.
format ChartForgeX.Core.RasterImageFormat requiredposition: 2: The raster image format.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 3: Optional raster export options.

WriteTiff 2 overloads

public static Void WriteTiff(VisualGrid grid, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual grid to a TIFF stream.

Parameters

grid ChartForgeX.VisualBlocks.VisualGrid requiredposition: 0: The visual grid to render.
stream System.IO.Stream requiredposition: 1: The destination stream.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

public static Void WriteTiff(VisualCanvas canvas, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual canvas to a TIFF stream.

Parameters

canvas ChartForgeX.Composition.VisualCanvas requiredposition: 0
stream System.IO.Stream requiredposition: 1
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2