API Reference

Interface

IVisualBlock

Namespace ChartForgeX.VisualBlocks

Assembly ChartForgeX

Implements

IStaticVisualSource

Modifiers abstract

Common contract for renderable non-chart visual blocks.

Usage

Explore 56 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Property VisualGridItem.Block

Accepted by parameters 55

Method ChartExtensions.Save parameter block
Method ChartExtensions.SaveBmp parameter block
Method ChartExtensions.SaveHtml parameter block
Method ChartExtensions.SavePng parameter block
Method ChartExtensions.SavePpm parameter block
Method ChartExtensions.SaveRasterImage parameter block
Method ChartExtensions.SaveSvg parameter block
Method ChartExtensions.SaveTiff parameter block
Method ChartExtensions.ToBmp parameter block
Method ChartExtensions.ToHtmlFragment parameter block
Method ChartExtensions.ToHtmlPage parameter block
Method ChartExtensions.ToPng parameter block
Method ChartExtensions.ToPpm parameter block
Method ChartExtensions.ToRasterImage parameter block
Method ChartExtensions.ToRgbaImage parameter block
Method ChartExtensions.ToSvg parameter block
Method ChartExtensions.ToTiff parameter block
Method ChartExtensions.WriteBmp parameter block
Method ChartExtensions.WritePpm parameter block
Method ChartExtensions.WriteRasterImage parameter block
Method ChartExtensions.WriteTiff parameter block
Method ImageComposition.DrawVisualBlock parameter block
Extension method VisualCanvas.AddVisualBlock parameter block
Method CompositeArtifactRendering.ToVisualArtifact parameter block
Method HtmlVisualBlockRenderer.RenderFragment parameter block
Method HtmlVisualBlockRenderer.RenderPage parameter block
Extension method IVisualBlock.Save parameter block
Extension method IVisualBlock.SaveBmp parameter block
Extension method IVisualBlock.SaveHtml parameter block
Extension method IVisualBlock.SavePng parameter block
Extension method IVisualBlock.SavePpm parameter block
Extension method IVisualBlock.SaveRasterImage parameter block
Extension method IVisualBlock.SaveSvg parameter block
Extension method IVisualBlock.SaveTiff parameter block
Extension method IVisualBlock.ToBmp parameter block
Extension method IVisualBlock.ToHtmlFragment parameter block
Extension method IVisualBlock.ToHtmlPage parameter block
Extension method IVisualBlock.ToPng parameter block
Extension method IVisualBlock.ToPpm parameter block
Extension method IVisualBlock.ToRasterImage parameter block
Extension method IVisualBlock.ToRgbaImage parameter block
Extension method IVisualBlock.ToSvg parameter block
Extension method IVisualBlock.ToTiff parameter block
Extension method IVisualBlock.ToVisualArtifact parameter block
Extension method IVisualBlock.WriteBmp parameter block
Extension method IVisualBlock.WritePpm parameter block
Extension method IVisualBlock.WriteRasterImage parameter block
Extension method IVisualBlock.WriteTiff parameter block
Method PngFactBlockRenderer.Render parameter block
Method PngVisualBlockRenderer.Render parameter block
Method SvgFactBlockRenderer.Render parameter block
Method SvgVisualBlockRenderer.Render parameter block
Method VisualGrid.Add parameter block
Method VisualGridItem.FromBlock parameter block
Method VisualsExtensions.AddVisualBlock parameter block

Properties

public abstract String Title { get; } #

Gets the block title.

public abstract String Subtitle { get; } #

Gets the block subtitle.

public abstract VisualBlockOptions Options { get; } #

Gets shared rendering options.

public abstract String AccessibleName { get; } #

Gets a concise accessibility label.

Extension Methods

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.

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.

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.

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.

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 2 overloads

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 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.

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.

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 2 overloads

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.

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[] 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[] 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.

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 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 2 overloads

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.

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.

public static VisualArtifact ToVisualArtifact(IVisualBlock block, String? id = null, VisualArtifactSourceLanguage sourceLanguage = Native)

Returns: VisualArtifact

Wraps a non-chart visual block in a reusable visual artifact.

Parameters

block ChartForgeX.VisualBlocks.IVisualBlock requiredposition: 0
id System.String? = null optionalposition: 1
sourceLanguage ChartForgeX.VisualArtifacts.VisualArtifactSourceLanguage = Native optionalposition: 2

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.

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.

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 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.