API Reference

Class

ChartExtensions

Namespace ChartForgeX

Assembly ChartForgeX

Modifiers static

Provides convenience rendering and file export methods for charts.

Inheritance

Object
ChartExtensions

Methods

ConfigureTheme 2 overloads

public static Chart ConfigureTheme(Chart chart, Action<ChartTheme> configure) #

Returns: Chart

Configures the current chart theme in place.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to configure.
configure System.Action<ChartForgeX.Themes.ChartTheme> requiredposition: 1: The theme customization callback.

Returns

The current chart.

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

Returns: ChartGrid

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to configure.
configure System.Action<ChartForgeX.Themes.ChartTheme> requiredposition: 1: The theme customization callback.

Returns

The current chart grid.

public static PngFontInfo GetPngFontInfo(Chart chart) #

Returns: PngFontInfo

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to inspect.

Returns

The PNG font resolution details.

Save 3 overloads

public static Void Save(Chart chart, String path, RasterImageOptions? rasterOptions = null) #

Returns: Void

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, String path, RasterImageOptions? rasterOptions = null) #

Returns: Void

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, String path, RasterImageOptions? rasterOptions = null) #

Returns: Void

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

Parameters

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

SaveBmp 3 overloads

public static Void SaveBmp(Chart chart, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a chart as a BMP file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a chart grid as a BMP file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual block as a BMP file.

Parameters

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

SaveHtml 3 overloads

public static Void SaveHtml(Chart chart, String path) #

Returns: Void

Saves a chart as a complete HTML file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.
path System.String requiredposition: 1: The output file path.

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

Returns: Void

Saves a chart grid as a complete HTML file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.
path System.String requiredposition: 1: The output file path.

public static Void SaveHtml(IVisualBlock block, String path) #

Returns: Void

Saves a visual block as a complete HTML file.

Parameters

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

SavePng 3 overloads

public static Void SavePng(Chart chart, String path) #

Returns: Void

Saves a chart as a PNG file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.
path System.String requiredposition: 1: The output file path.

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

Returns: Void

Saves a chart grid as a PNG file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.
path System.String requiredposition: 1: The output file path.

public static Void SavePng(IVisualBlock block, String path) #

Returns: Void

Saves a visual block as a PNG file.

Parameters

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

SavePpm 3 overloads

public static Void SavePpm(Chart chart, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a chart as a PPM file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a chart grid as a PPM file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual block as a PPM file.

Parameters

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

SaveRasterImage 8 overloads

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

Returns: Void

Saves a chart as an opaque raster image file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(Chart chart, String path, RasterImageOptions? options = null) #

Returns: Void

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, String path, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Saves a chart grid as an opaque raster image file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(ChartGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, String path, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Saves a visual block as an opaque raster image file.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block 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(IVisualBlock block, String path, RasterImageOptions? options = null) #

Returns: Void

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

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block 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(RgbaImage image, String path, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Saves RGBA pixels to a dependency-free raster file.

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0: The image to encode.
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(RgbaImage image, String path, RasterImageOptions? options = null) #

Returns: Void

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

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0: The image to encode.
path System.String requiredposition: 1: The output file path.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 2: Optional raster export options.

SaveSvg 3 overloads

public static Void SaveSvg(Chart chart, String path) #

Returns: Void

Saves a chart as an SVG file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.
path System.String requiredposition: 1: The output file path.

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

Returns: Void

Saves a chart grid as an SVG file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.
path System.String requiredposition: 1: The output file path.

public static Void SaveSvg(IVisualBlock block, String path) #

Returns: Void

Saves a visual block as an SVG file.

Parameters

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

SaveTiff 3 overloads

public static Void SaveTiff(Chart chart, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a chart as a TIFF file.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a chart grid as a TIFF file.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, String path, RasterImageOptions? options = null) #

Returns: Void

Saves a visual block as a TIFF file.

Parameters

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

ToBmp 3 overloads

public static Byte[] ToBmp(Chart chart, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a chart to BMP bytes.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A BMP image.

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

Returns: Byte[]

Renders a chart grid to BMP bytes.

Parameters

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

Returns

A BMP image.

public static Byte[] ToBmp(IVisualBlock block, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual block to BMP bytes.

Parameters

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

Returns

A BMP image.

ToHtmlFragment 6 overloads

public static String ToHtmlFragment(Chart chart) #

Returns: String

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.

Returns

An HTML fragment.

public static String ToHtmlFragment(Chart chart, String idScope) #

Returns: String

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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.

public static String ToHtmlFragment(ChartGrid grid) #

Returns: String

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.

Returns

An HTML fragment.

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

Returns: String

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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.

public static String ToHtmlFragment(IVisualBlock block) #

Returns: String

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

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block to render.

Returns

An HTML fragment.

public static String ToHtmlFragment(IVisualBlock block, String idScope) #

Returns: String

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

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block 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 3 overloads

public static String ToHtmlPage(Chart chart) #

Returns: String

Renders a chart to a complete HTML document.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.

Returns

An HTML page.

public static String ToHtmlPage(ChartGrid grid) #

Returns: String

Renders a chart grid to a complete HTML document.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.

Returns

An HTML page.

public static String ToHtmlPage(IVisualBlock block) #

Returns: String

Renders a visual block to a complete HTML document.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block to render.

Returns

An HTML page.

public static Byte[] ToJpeg(RgbaImage image, RasterImageOptions? options = null) #

Returns: Byte[]

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

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0: The image to encode.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A JPEG image.

ToPng 5 overloads

public static Byte[] ToPng(Chart chart) #

Returns: Byte[]

Renders a chart to PNG bytes.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.

Returns

A PNG image.

public static Byte[] ToPng(ChartGrid grid) #

Returns: Byte[]

Renders a chart grid to PNG bytes.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.

Returns

A PNG image.

public static Byte[] ToPng(IVisualBlock block) #

Returns: Byte[]

Renders a visual block to PNG bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block to render.

Returns

A PNG image.

public static Byte[] ToPng(RgbaImage image) #

Returns: Byte[]

Encodes RGBA pixels to PNG bytes.

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0: The image to encode.

Returns

A PNG image.

public static Byte[] ToPng(RgbaImage image, RasterImageOptions? options) #

Returns: Byte[]

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

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0
options ChartForgeX.Core.RasterImageOptions? requiredposition: 1

ToPpm 3 overloads

public static Byte[] ToPpm(Chart chart, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a chart to PPM bytes.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A PPM image.

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

Returns: Byte[]

Renders a chart grid to PPM bytes.

Parameters

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

Returns

A PPM image.

public static Byte[] ToPpm(IVisualBlock block, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual block to PPM bytes.

Parameters

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

Returns

A PPM image.

ToRasterImage 4 overloads

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

Returns: Byte[]

Renders a chart to opaque raster image bytes.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, RasterImageFormat format, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a chart grid to opaque raster image bytes.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, RasterImageFormat format, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual block to opaque raster image bytes.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block 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(RgbaImage image, RasterImageFormat format, RasterImageOptions? options = null) #

Returns: Byte[]

Encodes RGBA pixels to a dependency-free raster format.

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0: The image to encode.
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 3 overloads

public static RgbaImage ToRgbaImage(Chart chart) #

Returns: RgbaImage

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.

Returns

The rendered RGBA image.

public static RgbaImage ToRgbaImage(ChartGrid grid) #

Returns: RgbaImage

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.

Returns

The rendered RGBA image.

public static RgbaImage ToRgbaImage(IVisualBlock block) #

Returns: RgbaImage

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

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block to render.

Returns

The rendered RGBA image.

ToSvg 6 overloads

public static String ToSvg(Chart chart) #

Returns: String

Renders a chart to SVG markup.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.

Returns

SVG markup.

public static String ToSvg(Chart chart, String idScope) #

Returns: String

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

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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.

public static String ToSvg(ChartGrid grid) #

Returns: String

Renders a chart grid to SVG markup.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart grid to render.

Returns

SVG markup.

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

Returns: String

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

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block) #

Returns: String

Renders a visual block to SVG markup.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block to render.

Returns

SVG markup.

public static String ToSvg(IVisualBlock block, String idScope) #

Returns: String

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

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block 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 3 overloads

public static Byte[] ToTiff(Chart chart, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a chart to TIFF bytes.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to render.
options ChartForgeX.Core.RasterImageOptions? = null optionalposition: 1: Optional raster export options.

Returns

A TIFF image.

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

Returns: Byte[]

Renders a chart grid to TIFF bytes.

Parameters

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

Returns

A TIFF image.

public static Byte[] ToTiff(IVisualBlock block, RasterImageOptions? options = null) #

Returns: Byte[]

Renders a visual block to TIFF bytes.

Parameters

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

Returns

A TIFF image.

WithBrandKit 2 overloads

public static Chart WithBrandKit(Chart chart, ChartBrandKit brandKit) #

Returns: Chart

Applies a reusable brand kit to the current chart theme.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to configure.
brandKit ChartForgeX.Themes.ChartBrandKit requiredposition: 1: The brand kit to apply.

Returns

The current chart.

public static ChartGrid WithBrandKit(ChartGrid grid, ChartBrandKit brandKit) #

Returns: ChartGrid

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 requiredposition: 0: The chart grid to configure.
brandKit ChartForgeX.Themes.ChartBrandKit requiredposition: 1: The brand kit to apply.

Returns

The current chart grid.

public static TBlock WithBrandKit<TBlock>(TBlock block, ChartBrandKit brandKit) #

Returns: TBlock

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

Type Parameters

TBlock: The visual block type.

Parameters

block TBlock requiredposition: 0: The visual block to configure.
brandKit ChartForgeX.Themes.ChartBrandKit requiredposition: 1: The brand kit to apply.

Returns

The current visual block.

WithPalette 2 overloads

public static Chart WithPalette(Chart chart, params ChartColor[] colors) #

Returns: Chart

Sets the default series palette on the current chart theme.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart to configure.
colors ChartForgeX.Primitives.ChartColor[] requiredposition: 1: The palette colors.

Returns

The current chart.

public static Chart WithPalette(Chart chart, params String[] colors) #

Returns: Chart

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

Parameters

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

Returns

The current chart.

WithPalette``1 2 overloads

public static TBlock WithPalette<TBlock>(TBlock block, params ChartColor[] colors) #

Returns: TBlock

Sets the default palette on the current visual block theme.

Type Parameters

TBlock: The visual block type.

Parameters

block TBlock requiredposition: 0: The visual block to configure.
colors ChartForgeX.Primitives.ChartColor[] requiredposition: 1: The palette colors.

Returns

The current visual block.

public static TBlock WithPalette<TBlock>(TBlock block, params String[] colors) #

Returns: TBlock

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

Type Parameters

TBlock: The visual block type.

Parameters

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

Returns

The current visual block.

public static TBlock WithPngOutputScale<TBlock>(TBlock block, ChartPngOutputScale scale) #

Returns: TBlock

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 TBlock requiredposition: 0: The visual block to configure.
scale ChartForgeX.Core.ChartPngOutputScale requiredposition: 1: The output density preset.

Returns

The current visual block.

WriteBmp 3 overloads

public static Void WriteBmp(Chart chart, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a chart to a BMP stream.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a chart grid to a BMP stream.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual block to a BMP stream.

Parameters

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

WritePpm 3 overloads

public static Void WritePpm(Chart chart, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a chart to a PPM stream.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a chart grid to a PPM stream.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual block to a PPM stream.

Parameters

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

WriteRasterImage 4 overloads

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

Returns: Void

Writes a chart to an opaque raster image stream.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, Stream stream, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Writes a chart grid to an opaque raster image stream.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, Stream stream, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Writes a visual block to an opaque raster image stream.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0: The visual block 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(RgbaImage image, Stream stream, RasterImageFormat format, RasterImageOptions? options = null)

Returns: Void

Writes RGBA pixels to a dependency-free raster stream.

Parameters

image ChartForgeX.Raster.RgbaImage requiredposition: 0: The image to encode.
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 3 overloads

public static Void WriteTiff(Chart chart, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a chart to a TIFF stream.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0: The chart 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(ChartGrid grid, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a chart grid to a TIFF stream.

Parameters

grid ChartForgeX.Core.ChartGrid requiredposition: 0: The chart 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(IVisualBlock block, Stream stream, RasterImageOptions? options = null) #

Returns: Void

Writes a visual block to a TIFF stream.

Parameters

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