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

PreparedVisual

Namespace ChartForgeX.Rendering
Assembly ChartForgeX
Modifiers sealed

A detached immutable scene. SVG and native raster export consume the same prepared decisions.

Inheritance

  • Object
  • PreparedVisual

Usage

Explore 14 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 10

Accepted by parameters 4

Methods

public Byte[] ToPng(VisualRenderOptions? options = null) #
Returns: Byte[]

Exports PNG from the native raster backend.

Parameters

options ChartForgeX.Rendering.VisualRenderOptions? = null optionalposition: 0
public RgbaImage ToRgba(VisualRenderOptions? options = null) #
Returns: RgbaImage

Exports native RGBA pixels without repeating layout or parsing SVG.

Parameters

options ChartForgeX.Rendering.VisualRenderOptions? = null optionalposition: 0
ToSvg 3 overloads
public String ToSvg() #
Returns: String

Exports script-free SVG without repeating layout.

public String ToSvg(String idPrefix) #
Returns: String

Exports SVG with a host-owned ID namespace, allowing identical prepared visuals in one document.

Parameters

idPrefix System.String requiredposition: 0
A unique host prefix beginning with an ASCII letter and containing only letters, digits, hyphens, underscores and periods.
public String ToSvg(VisualSvgOptions options) #
Returns: String

Exports SVG using detached host namespace, color and safe link policies.

Parameters

options ChartForgeX.Rendering.VisualSvgOptions requiredposition: 0

Properties

public VisualSize Size { get; } #

Gets the logical viewport.

public IReadOnlyList<VisualDiagnostic> Diagnostics { get; } #

Gets preparation diagnostics.

public IReadOnlyList<VisualSemanticRegion> Regions { get; } #

Gets descriptive source regions.

public VisualAccessibility Accessibility { get; } #

Gets an independent copy of the text alternative.

Extension Methods

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.