Project

ChartForgeX

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

View on GitHub Visit Website Releases Get package
Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

VisualCanvas

Namespace ChartForgeX.Composition

A fixed-size layered visual surface for wallpapers, social images, report covers, and hero graphics.

Inheritance

  • Object
  • VisualCanvas

Usage

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

Accepted by parameters

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

Methods

AddFeatureStrip 2 overloads
AddFeatureStrip(System.Double arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasFeatureItem} arg5) #

Adds a compact feature strip.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasFeatureItem} required
AddFeatureStrip(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3, System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasFeatureItem} arg4) #

Adds a compact feature strip using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
arg4 System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasFeatureItem} required
AddHeroBadge 4 overloads
AddHeroBadge(System.Double arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.String arg5, System.Nullable{ChartForgeX.Primitives.ChartColor} arg6) #

Adds a central icon or logo badge.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.String required
arg6 System.Nullable{ChartForgeX.Primitives.ChartColor} required
AddHeroBadge(System.Double arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.String arg5, System.Nullable{ChartForgeX.Primitives.ChartColor} arg6, System.String arg7, System.Byte[] arg8, System.Int32 arg9, System.Int32 arg10, ChartForgeX.Composition.VisualCanvasImageFit arg11, System.Double arg12, System.Double arg13) #

Adds a central icon or logo badge with optional image content.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.String required
arg6 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg7 System.String required
arg8 System.Byte[] required
arg9 System.Int32 required
arg10 System.Int32 required
arg11 ChartForgeX.Composition.VisualCanvasImageFit required
arg12 System.Double required
arg13 System.Double required
AddHeroBadge(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3, System.String arg4, System.Nullable{ChartForgeX.Primitives.ChartColor} arg5) #

Adds a central icon or logo badge using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
arg4 System.String required
arg5 System.Nullable{ChartForgeX.Primitives.ChartColor} required
AddHeroBadge(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3, System.String arg4, System.Nullable{ChartForgeX.Primitives.ChartColor} arg5, System.String arg6, System.Byte[] arg7, System.Int32 arg8, System.Int32 arg9, ChartForgeX.Composition.VisualCanvasImageFit arg10, System.Double arg11, System.Double arg12) #

Adds a central icon or logo badge with optional image content using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
arg4 System.String required
arg5 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg6 System.String required
arg7 System.Byte[] required
arg8 System.Int32 required
arg9 System.Int32 required
arg10 ChartForgeX.Composition.VisualCanvasImageFit required
arg11 System.Double required
arg12 System.Double required
AddHeroTitle 2 overloads
AddHeroTitle(System.Double arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasTextRun} arg5, ChartForgeX.Typography.TextAlignment arg6) #

Adds a multi-color hero title layer.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasTextRun} required
arg6 ChartForgeX.Typography.TextAlignment required
AddHeroTitle(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3, System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasTextRun} arg4, ChartForgeX.Typography.TextAlignment arg5) #

Adds a multi-color hero title layer using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
arg4 System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasTextRun} required
arg5 ChartForgeX.Typography.TextAlignment required
AddImage 2 overloads
AddImage(System.Double arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.String arg5, System.Byte[] arg6, System.Int32 arg7, System.Int32 arg8, System.Double arg9, ChartForgeX.Composition.VisualCanvasImageFit arg10) #

Adds an image layer. SVG output uses href; PNG output uses rgba when supplied.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.String required
arg6 System.Byte[] required
arg7 System.Int32 required
arg8 System.Int32 required
arg9 System.Double required
arg10 ChartForgeX.Composition.VisualCanvasImageFit required
AddImage(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3, System.String arg4, System.Byte[] arg5, System.Int32 arg6, System.Int32 arg7, System.Double arg8, ChartForgeX.Composition.VisualCanvasImageFit arg9) #

Adds an image layer using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
arg4 System.String required
arg5 System.Byte[] required
arg6 System.Int32 required
arg7 System.Int32 required
arg8 System.Double required
arg9 ChartForgeX.Composition.VisualCanvasImageFit required
AddInfoTile 2 overloads
AddInfoTile(System.Double arg1, System.Double arg2, System.Double arg3, System.Double arg4, System.String arg5, System.String arg6, System.String arg7, System.String arg8, System.Nullable{ChartForgeX.Primitives.ChartColor} arg9, System.Nullable{System.Double} arg10, ChartForgeX.Composition.VisualCanvasInfoTileSurfaceStyle arg11, ChartForgeX.Composition.VisualCanvasInfoTileIconKind arg12, ChartForgeX.Composition.VisualCanvasInfoTileMiniChartKind arg13, System.Collections.Generic.IEnumerable{System.Double} arg14, System.Nullable{System.Double} arg15, ChartForgeX.Composition.VisualCanvasTextFitPolicy arg16) #

Adds a reusable information tile.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Double required
arg5 System.String required
arg6 System.String required
arg7 System.String required
arg8 System.String required
arg9 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg10 System.Nullable{System.Double} required
arg11 ChartForgeX.Composition.VisualCanvasInfoTileSurfaceStyle required
arg12 ChartForgeX.Composition.VisualCanvasInfoTileIconKind required
arg13 ChartForgeX.Composition.VisualCanvasInfoTileMiniChartKind required
arg14 System.Collections.Generic.IEnumerable{System.Double} required
arg15 System.Nullable{System.Double} required
arg16 ChartForgeX.Composition.VisualCanvasTextFitPolicy required
AddInfoTile(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3, System.String arg4, System.String arg5, System.String arg6, System.String arg7, System.Nullable{ChartForgeX.Primitives.ChartColor} arg8, System.Nullable{System.Double} arg9, ChartForgeX.Composition.VisualCanvasInfoTileSurfaceStyle arg10, ChartForgeX.Composition.VisualCanvasInfoTileIconKind arg11, ChartForgeX.Composition.VisualCanvasInfoTileMiniChartKind arg12, System.Collections.Generic.IEnumerable{System.Double} arg13, System.Nullable{System.Double} arg14, ChartForgeX.Composition.VisualCanvasTextFitPolicy arg15) #

Adds a reusable information tile using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
arg4 System.String required
arg5 System.String required
arg6 System.String required
arg7 System.String required
arg8 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg9 System.Nullable{System.Double} required
arg10 ChartForgeX.Composition.VisualCanvasInfoTileSurfaceStyle required
arg11 ChartForgeX.Composition.VisualCanvasInfoTileIconKind required
arg12 ChartForgeX.Composition.VisualCanvasInfoTileMiniChartKind required
arg13 System.Collections.Generic.IEnumerable{System.Double} required
arg14 System.Nullable{System.Double} required
arg15 ChartForgeX.Composition.VisualCanvasTextFitPolicy required
AddKeyValueBlock 2 overloads
AddKeyValueBlock(System.Double arg1, System.Double arg2, System.Double arg3, System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasKeyValueItem} arg4, System.Double arg5, System.Double arg6, System.Double arg7, System.Double arg8, System.Nullable{System.Double} arg9, System.Nullable{System.Double} arg10, System.Nullable{ChartForgeX.Primitives.ChartColor} arg11, System.Nullable{ChartForgeX.Primitives.ChartColor} arg12, System.String arg13) #

Adds a key/value text block with measured columns and wrapped values.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasKeyValueItem} required
arg5 System.Double required
arg6 System.Double required
arg7 System.Double required
arg8 System.Double required
arg9 System.Nullable{System.Double} required
arg10 System.Nullable{System.Double} required
arg11 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg12 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg13 System.String required
AddKeyValueBlock(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasKeyValueItem} arg3, System.Double arg4, System.Double arg5, System.Double arg6, System.Double arg7, System.Nullable{System.Double} arg8, System.Nullable{System.Double} arg9, System.Nullable{ChartForgeX.Primitives.ChartColor} arg10, System.Nullable{ChartForgeX.Primitives.ChartColor} arg11, System.String arg12) #

Adds a key/value text block with measured columns and wrapped values using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Collections.Generic.IEnumerable{ChartForgeX.Composition.VisualCanvasKeyValueItem} required
arg4 System.Double required
arg5 System.Double required
arg6 System.Double required
arg7 System.Double required
arg8 System.Nullable{System.Double} required
arg9 System.Nullable{System.Double} required
arg10 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg11 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg12 System.String required
AddLayer(ChartForgeX.Composition.VisualCanvasLayer arg1) #

Adds a layer to the canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasLayer required
AddText 2 overloads
AddText(System.Double arg1, System.Double arg2, System.Double arg3, System.String arg4, System.Double arg5, ChartForgeX.Primitives.ChartColor arg6, ChartForgeX.Typography.TextAlignment arg7, System.Boolean arg8) #

Adds a plain text layer.

Parameters

arg1 System.Double required
arg2 System.Double required
arg3 System.Double required
arg4 System.String required
arg5 System.Double required
arg6 ChartForgeX.Primitives.ChartColor required
arg7 ChartForgeX.Typography.TextAlignment required
arg8 System.Boolean required
AddText(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.String arg3, System.Double arg4, ChartForgeX.Primitives.ChartColor arg5, ChartForgeX.Typography.TextAlignment arg6, System.Boolean arg7) #

Adds a plain text layer using anchor-based placement.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.String required
arg4 System.Double required
arg5 ChartForgeX.Primitives.ChartColor required
arg6 ChartForgeX.Typography.TextAlignment required
arg7 System.Boolean required
AnalyzeLayout() #

Analyzes canvas layer bounds and built-in text fitting decisions without rendering.

AsDecorative(System.Boolean arg1) #

Marks the canvas as decorative for capable renderers.

Parameters

arg1 System.Boolean required
Create(System.Int32 arg1, System.Int32 arg2) #

Creates a fixed-size visual canvas.

Parameters

arg1 System.Int32 required
arg2 System.Int32 required
CreateDesktopWallpaper() #

Creates a 1920 by 1080 desktop wallpaper canvas.

CreateSocialPreview() #

Creates a 1200 by 630 social preview canvas.

ResolvePlacement(ChartForgeX.Composition.VisualCanvasPlacement arg1, System.Double arg2, System.Double arg3) #

Resolves anchor-based placement against the full canvas.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasPlacement required
arg2 System.Double required
arg3 System.Double required
WithAccessibility(System.Action{ChartForgeX.Accessibility.VisualAccessibility} arg1) #

Configures the canvas text alternative and language metadata.

Parameters

arg1 System.Action{ChartForgeX.Accessibility.VisualAccessibility} required
WithBackdrop(ChartForgeX.Composition.VisualCanvasBackdropStyle arg1) #

Sets the built-in backdrop decoration style.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasBackdropStyle required
WithBackground 2 overloads
WithBackground(ChartForgeX.Primitives.ChartColor arg1) #

Sets a solid background color.

Parameters

arg1 ChartForgeX.Primitives.ChartColor required
WithBackground(ChartForgeX.Primitives.ChartColor arg1, ChartForgeX.Primitives.ChartColor arg2) #

Sets a vertical background gradient.

Parameters

arg1 ChartForgeX.Primitives.ChartColor required
arg2 ChartForgeX.Primitives.ChartColor required
WithDesignTokens(ChartForgeX.Themes.VisualDesignTokens arg1) #

Applies shared product-neutral design tokens to the canvas and its renderer theme.

Parameters

arg1 ChartForgeX.Themes.VisualDesignTokens required
WithFixedLayout() #

Uses output dimensions as the layer coordinate space again.

WithOutputSize(System.Int32 arg1, System.Int32 arg2) #

Sets output dimensions without changing layer coordinates.

Parameters

arg1 System.Int32 required
arg2 System.Int32 required
WithPngOutputScale(System.Int32 arg1) #

Sets the PNG output pixel multiplier.

Parameters

arg1 System.Int32 required
WithResponsiveLayout(System.Int32 arg1, System.Int32 arg2, ChartForgeX.Composition.VisualCanvasImageFit arg3) #

Preserves a design coordinate space while adapting SVG and PNG output to other dimensions.

Parameters

arg1 System.Int32 required
arg2 System.Int32 required
arg3 ChartForgeX.Composition.VisualCanvasImageFit required
WithTheme(ChartForgeX.Composition.VisualCanvasTheme arg1) #

Sets the theme used by built-in visual canvas layers.

Parameters

arg1 ChartForgeX.Composition.VisualCanvasTheme required
WithTitle(System.String arg1) #

Sets the accessibility title used by SVG output.

Parameters

arg1 System.String required

Properties

Accessibility #

Gets accessibility metadata shared by capable renderers and hosts.

DesignWidth #

Gets the coordinate-space width used to lay out layers.

DesignHeight #

Gets the coordinate-space height used to lay out layers.

IsResponsive #

Gets whether output dimensions differ from the layer design coordinate space.

ResponsiveFit #

Gets or sets how the design coordinate space fits the requested output size.

Width #

Gets or sets the canvas width in pixels.

Height #

Gets or sets the canvas height in pixels.

Title #

Gets or sets the accessibility title used by SVG output.

BackgroundTop #

Gets or sets the top background color.

BackgroundBottom #

Gets or sets the bottom background color.

BackdropStyle #

Gets or sets the optional backdrop decoration style.

Theme #

Gets or sets the theme used by built-in visual canvas layers.

PngOutputScale #

Gets or sets the PNG output pixel multiplier.

Layers #

Gets the ordered visual canvas layers.