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

FlowArtifact

Namespace ChartForgeX.VisualArtifacts
Assembly ChartForgeX
Implements
IVisualRenderable
Modifiers sealed

Represents a product-neutral workflow or process flow artifact.

Inheritance

  • Object
  • FlowArtifact

Usage

Explore 21 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 11

Accepted by parameters 10

Constructors

public FlowArtifact() #

Methods

public FlowArtifact AddConnector(String sourceId, String targetId, String label = "", FlowArtifactConnectorKind kind = Flow, VisualLinkDirection direction = Forward, VisualStatus status = None, String? color = null) #
Returns: FlowArtifact

Adds a flow connector.

Parameters

sourceId System.String requiredposition: 0
targetId System.String requiredposition: 1
label System.String = "" optionalposition: 2
kind ChartForgeX.VisualArtifacts.FlowArtifactConnectorKind = Flow optionalposition: 3
direction ChartForgeX.Primitives.VisualLinkDirection = Forward optionalposition: 4
status ChartForgeX.VisualBlocks.VisualStatus = None optionalposition: 5
color System.String? = null optionalposition: 6
public FlowArtifact AddLane(String id, String label, VisualStatus status = None, String? color = null) #
Returns: FlowArtifact

Adds a flow lane.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
status ChartForgeX.VisualBlocks.VisualStatus = None optionalposition: 2
color System.String? = null optionalposition: 3
public FlowArtifact AddStep(String id, String label, FlowArtifactStepKind kind = Step, String? laneId = null, VisualStatus status = None) #
Returns: FlowArtifact

Adds a flow step.

Parameters

id System.String requiredposition: 0
label System.String requiredposition: 1
kind ChartForgeX.VisualArtifacts.FlowArtifactStepKind = Step optionalposition: 2
laneId System.String? = null optionalposition: 3
status ChartForgeX.VisualBlocks.VisualStatus = None optionalposition: 4
public FlowArtifact ConfigureConnector(Int32 connectorIndex, Action<FlowArtifactConnector> configure) #
Returns: FlowArtifact

Configures one existing connector.

Parameters

connectorIndex System.Int32 requiredposition: 0
configure System.Action<ChartForgeX.VisualArtifacts.FlowArtifactConnector> requiredposition: 1
public FlowArtifact ConfigureStep(String id, Action<FlowArtifactStep> configure) #
Returns: FlowArtifact

Configures one existing step.

Parameters

id System.String requiredposition: 0
configure System.Action<ChartForgeX.VisualArtifacts.FlowArtifactStep> requiredposition: 1
public static FlowArtifact Create(String id) #
Returns: FlowArtifact

Creates a new flow artifact.

Parameters

id System.String requiredposition: 0
public PreparedVisual Prepare(VisualRenderContext context) #
Returns: PreparedVisual

Prepares a flow through the shared topology compiler while retaining native flow semantics.

Parameters

context ChartForgeX.Rendering.VisualRenderContext requiredposition: 0
Common size, frame, theme and typography.

Returns

A detached static scene and resolved native flow geometry.

public Boolean SupportsExport(VisualArtifactExportFormat format) #
Returns: Boolean

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

Parameters

format ChartForgeX.VisualArtifacts.VisualArtifactExportFormat requiredposition: 0
public FlowArtifact WithSize(Double width, Double height, Double padding = 24) #
Returns: FlowArtifact

Sets the static preview size.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
padding System.Double = 24 optionalposition: 2
public FlowArtifact WithSubtitle(String subtitle) #
Returns: FlowArtifact

Sets the flow subtitle.

Parameters

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

Sets the flow title.

Parameters

title System.String requiredposition: 0

Properties

public String Id { get; set; } #

Gets or sets a stable flow identifier.

public String Title { get; set; } #

Gets or sets the flow title.

public String Subtitle { get; set; } #

Gets or sets the flow subtitle.

public FlowArtifactLayoutMode LayoutMode { get; set; } #

Gets or sets the deterministic layout mode.

public FlowArtifactDirection Direction { get; set; } #

Gets or sets the deterministic layout direction.

public Double Width { get; set; } #

Gets or sets the static preview width.

public Double Height { get; set; } #

Gets or sets the static preview height.

public Double Padding { get; set; } #

Gets or sets the static preview padding.

public IReadOnlyList<FlowArtifactLane> Lanes { get; } #

Gets declared flow lanes.

public IReadOnlyList<FlowArtifactStep> Steps { get; } #

Gets declared flow steps.

public IReadOnlyList<FlowArtifactConnector> Connectors { get; } #

Gets declared flow connectors.

public VisualArtifactExportFormat ExportFormats { get; set; } #

Gets or sets static export formats declared by this artifact.

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

Gets metadata for host adapters and exporters.

Extension Methods

public static String ToHtmlPage(FlowArtifact flow) #
Returns: String

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

Parameters

flow ChartForgeX.VisualArtifacts.FlowArtifact requiredposition: 0
The flow artifact.

Returns

HTML markup.

public static Byte[] ToPng(FlowArtifact flow) #
Returns: Byte[]

Renders a flow artifact static preview to PNG.

Parameters

flow ChartForgeX.VisualArtifacts.FlowArtifact requiredposition: 0
The flow artifact.

Returns

PNG bytes.

public static String ToSvg(FlowArtifact flow) #
Returns: String

Renders a flow artifact static preview to SVG.

Parameters

flow ChartForgeX.VisualArtifacts.FlowArtifact requiredposition: 0
The flow artifact.

Returns

SVG markup.

public static TopologyChart ToTopologyChart(FlowArtifact flow) #
Returns: TopologyChart

Converts a flow artifact into a topology chart for deterministic static previews.

Parameters

flow ChartForgeX.VisualArtifacts.FlowArtifact requiredposition: 0
The flow artifact.

Returns

A topology chart preview model.

public static VisualArtifact ToVisualArtifact(FlowArtifact flow, VisualArtifactSourceLanguage sourceLanguage = Native) #
Returns: VisualArtifact

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

Parameters

flow ChartForgeX.VisualArtifacts.FlowArtifact requiredposition: 0
The flow artifact.
sourceLanguage ChartForgeX.VisualArtifacts.VisualArtifactSourceLanguage = Native optionalposition: 1
The source language that produced the flow.

Returns

A visual artifact envelope.