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

TableArtifact

Namespace ChartForgeX.VisualArtifacts
Assembly ChartForgeX
Modifiers sealed

Describes one reusable table artifact for static rendering and native-host interaction.

Inheritance

  • Object
  • TableArtifact

Usage

Explore 19 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 9

Accepted by parameters 10

Constructors

public TableArtifact() #

Methods

public TableArtifact AddColumn(String id, String label, TableArtifactColumnType type = Text, TextAlignment alignment = Left, Double? width = null) #
Returns: TableArtifact

Adds a table column.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
type ChartForgeX.VisualArtifacts.TableArtifactColumnType = Text optionalposition: 2
alignment ChartForgeX.Typography.TextAlignment = Left optionalposition: 3
width System.Double? = null optionalposition: 4
public TableArtifact AddRow(String key, params Object?[] values) #
Returns: TableArtifact

Adds an in-memory row used by static previews and small table hosts.

Parameters

key System.String requiredposition: 0
values System.Object?[] requiredposition: 1
public TableArtifact ConfigureRow(Int32 rowIndex, Action<TableArtifactRow> configure) #
Returns: TableArtifact

Configures one existing row.

Parameters

rowIndex System.Int32 requiredposition: 0
configure System.Action<ChartForgeX.VisualArtifacts.TableArtifactRow> requiredposition: 1
public static TableArtifact Create(String id) #
Returns: TableArtifact

Creates a new table artifact.

Parameters

id System.String requiredposition: 0
public Boolean Supports(TableArtifactCapabilities capability) #
Returns: Boolean

Returns true when the table declares the requested capability.

Parameters

capability ChartForgeX.VisualArtifacts.TableArtifactCapabilities requiredposition: 0
public Boolean SupportsExport(VisualArtifactExportFormat format) #
Returns: Boolean

Returns true when the table declares the requested static export format.

Parameters

format ChartForgeX.VisualArtifacts.VisualArtifactExportFormat requiredposition: 0
public TableArtifact WithCapabilities(TableArtifactCapabilities capabilities) #
Returns: TableArtifact

Sets declared host-level table capabilities.

Parameters

capabilities ChartForgeX.VisualArtifacts.TableArtifactCapabilities requiredposition: 0
public TableArtifact WithSubtitle(String subtitle) #
Returns: TableArtifact

Sets the table subtitle.

Parameters

subtitle System.String requiredposition: 0
public TableArtifact WithTitle(String title) #
Returns: TableArtifact

Sets the table title.

Parameters

title System.String requiredposition: 0

Properties

public String Id { get; set; } #

Gets or sets a stable table identifier.

public String Title { get; set; } #

Gets or sets the table title.

public String Subtitle { get; set; } #

Gets or sets the table subtitle.

public IReadOnlyList<TableArtifactColumn> Columns { get; } #

Gets table columns.

public IReadOnlyList<TableArtifactRow> Rows { get; } #

Gets in-memory table rows used by static previews and small tables.

public TableArtifactCapabilities Capabilities { get; set; } #

Gets or sets host-level capabilities declared by this artifact.

public VisualArtifactExportFormat ExportFormats { get; set; } #

Gets or sets static export formats declared by this artifact.

public Int64? TotalRowCount { get; set; } #

Gets or sets the total row count when the artifact is backed by virtualized data.

public Dictionary<String, String> Metadata { get; } #

Gets table metadata for host adapters and exporters.

Extension Methods

public static String ToHtmlPage(TableArtifact table) #
Returns: String

Renders a table artifact static preview to a standalone HTML page.

Parameters

table ChartForgeX.VisualArtifacts.TableArtifact requiredposition: 0
The table artifact.

Returns

HTML markup.

public static Byte[] ToPng(TableArtifact table) #
Returns: Byte[]

Renders a table artifact static preview to PNG.

Parameters

table ChartForgeX.VisualArtifacts.TableArtifact requiredposition: 0
The table artifact.

Returns

PNG bytes.

public static ChartTable ToPreviewBlock(TableArtifact table) #
Returns: ChartTable

Converts a table artifact into the existing static ChartForgeX table visual block.

Parameters

table ChartForgeX.VisualArtifacts.TableArtifact requiredposition: 0
The table artifact.

Returns

A static table preview block.

public static String ToSvg(TableArtifact table) #
Returns: String

Renders a table artifact static preview to SVG.

Parameters

table ChartForgeX.VisualArtifacts.TableArtifact requiredposition: 0
The table artifact.

Returns

SVG markup.

public static VisualArtifact ToVisualArtifact(TableArtifact table) #
Returns: VisualArtifact

Wraps a table artifact in a product-neutral visual artifact envelope.

Parameters

table ChartForgeX.VisualArtifacts.TableArtifact requiredposition: 0
The table artifact.

Returns

A visual artifact envelope.