Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

View on GitHub Releases Get package
Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

VisualArtifactRendering

Namespace ChartForgeX.VisualArtifacts
Assembly ChartForgeX
Modifiers static

Provides static rendering helpers for product-neutral visual artifact envelopes.

Inheritance

  • Object
  • VisualArtifactRendering

Methods

SaveHtml 2 overloads
public static Void SaveHtml(VisualArtifact artifact, String path) #
Returns: Void

Saves a supported visual artifact model to a standalone HTML page.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The artifact envelope.
path System.String requiredposition: 1
The target HTML path.
public static Void SaveHtml(VisualArtifact artifact, String path, VisualArtifactRenderOptions? options) #
Returns: Void

Saves a supported visual artifact model to standalone HTML with artifact-wide options.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 2
SavePng 2 overloads
public static Void SavePng(VisualArtifact artifact, String path) #
Returns: Void

Saves a supported visual artifact model to PNG.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The artifact envelope.
path System.String requiredposition: 1
The target PNG path.
public static Void SavePng(VisualArtifact artifact, String path, VisualArtifactRenderOptions? options) #
Returns: Void

Saves a supported visual artifact model to PNG with artifact-wide options.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 2
SaveSvg 2 overloads
public static Void SaveSvg(VisualArtifact artifact, String path) #
Returns: Void

Saves a supported visual artifact model to SVG.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The artifact envelope.
path System.String requiredposition: 1
The target SVG path.
public static Void SaveSvg(VisualArtifact artifact, String path, VisualArtifactRenderOptions? options) #
Returns: Void

Saves a supported visual artifact model to SVG with artifact-wide options.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
path System.String requiredposition: 1
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 2
ToArtifact 2 overloads
public static VisualArtifact ToArtifact(PreparedVisual prepared, String? id = null) #
Returns: VisualArtifact

Wraps a prepared visual using its captured semantic identity and family when available.

Parameters

prepared ChartForgeX.Rendering.PreparedVisual requiredposition: 0
The detached static output.
id System.String? = null optionalposition: 1
Optional host ID; defaults to the captured ID or "prepared-visual" for a scene without semantics.
public static VisualArtifact ToArtifact(PreparedVisual prepared, String id, VisualArtifactKind kind, VisualArtifactInterchangeEnvelope? semanticInterchange = null, String? title = null, String? subtitle = null) #
Returns: VisualArtifact

Wraps an immutable prepared visual for static export and portable host handoff.

Parameters

prepared ChartForgeX.Rendering.PreparedVisual requiredposition: 0
The detached static output.
id System.String requiredposition: 1
The stable artifact ID; it must match a supplied semantic envelope.
kind ChartForgeX.VisualArtifacts.VisualArtifactKind requiredposition: 2
The declared artifact kind; it must match a supplied semantic envelope.
semanticInterchange ChartForgeX.VisualArtifacts.VisualArtifactInterchangeEnvelope? = null optionalposition: 3
Optional source-model semantics, captured independently of the display scene.
title System.String? = null optionalposition: 4
Optional artifact title; defaults to the semantic title or prepared accessible name.
subtitle System.String? = null optionalposition: 5
Optional artifact subtitle; defaults to the semantic subtitle.

Returns

A mutable host envelope whose render model and captured semantic data are detached snapshots.

ToHtmlPage 2 overloads
public static String ToHtmlPage(VisualArtifact artifact) #
Returns: String

Renders a supported visual artifact model to a standalone HTML page.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The artifact envelope.

Returns

HTML markup.

public static String ToHtmlPage(VisualArtifact artifact, VisualArtifactRenderOptions? options) #
Returns: String

Renders a supported visual artifact model to a standalone HTML page with artifact-wide options.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 1
ToPng 2 overloads
public static Byte[] ToPng(VisualArtifact artifact) #
Returns: Byte[]

Renders a supported visual artifact model to PNG.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The artifact envelope.

Returns

PNG bytes.

public static Byte[] ToPng(VisualArtifact artifact, VisualArtifactRenderOptions? options) #
Returns: Byte[]

Renders a supported visual artifact model to PNG with artifact-wide options.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 1
public static RgbaImage ToRgbaImage(VisualArtifact artifact, VisualArtifactRenderOptions? options = null) #
Returns: RgbaImage

Renders an artifact directly to native pixels, before format encoding.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The source semantics and optional static presentation.
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? = null optionalposition: 1
Optional core rendering options. Raster encoding options apply when encoding the result.

Returns

A detached RGBA image at the producer's configured output density.

ToSvg 3 overloads
public static String ToSvg(VisualArtifact artifact) #
Returns: String

Renders a supported visual artifact model to SVG.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
The artifact envelope.

Returns

SVG markup.

public static String ToSvg(VisualArtifact artifact, VisualArtifactRenderOptions? options) #
Returns: String

Renders a supported visual artifact model to SVG with artifact-wide options.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 1
public static String ToSvg(VisualArtifact artifact, VisualArtifactRenderOptions? options, String idScope) #
Returns: String

Renders SVG with a caller-owned namespace for embedding several artifacts in one document.

Parameters

artifact ChartForgeX.VisualArtifacts.VisualArtifact requiredposition: 0
options ChartForgeX.VisualArtifacts.VisualArtifactRenderOptions? requiredposition: 1
idScope System.String requiredposition: 2