Skip to content
ChartForgeX

API Reference

Class

TopologyHtmlRenderer

Edit on GitHub
Namespace ChartForgeX.Topology
Assembly ChartForgeX
Source TopologyHtmlRenderer.cs:15
Modifiers sealed

Renders topology charts into simple HTML wrappers with inline SVG.

Inheritance

  • Object
  • TopologyHtmlRenderer

Constructors

public TopologyHtmlRenderer() #
TopologyHtmlRenderer.cs:15

Methods

public static String BuildFragmentStyle(TopologyRenderOptions? options = null, VisualTheme? theme = null, VisualThemeMode mode = Light) #
TopologyHtmlRenderer.cs:201
Returns: String

Builds the renderer-owned stylesheet used by topology HTML fragments.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 0
Optional render options whose CSS prefix should be honored.
theme ChartForgeX.Themes.VisualTheme? = null optionalposition: 1
Optional topology theme whose font family should be used.
mode ChartForgeX.Themes.VisualThemeMode = Light optionalposition: 2
The explicit palette mode for the host surface.

Returns

CSS ready to register once in a host document.

public String RenderFragment(TopologyChart chart, TopologyRenderOptions? options = null) #
TopologyHtmlRenderer.cs:24
Returns: String

Renders an embeddable HTML fragment.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

An HTML fragment.

public String RenderFragmentWithoutAssets(TopologyChart chart, TopologyRenderOptions? options = null) #
TopologyHtmlRenderer.cs:37
Returns: String

Renders an embeddable HTML fragment without renderer-owned stylesheet or script assets.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

An HTML fragment that expects the caller to register topology HTML assets.

public String RenderPage(TopologyChart chart, TopologyRenderOptions? options = null) #
TopologyHtmlRenderer.cs:168
Returns: String

Renders a complete static HTML page containing one topology chart.

Parameters

chart ChartForgeX.Topology.TopologyChart requiredposition: 0
The topology chart.
options ChartForgeX.Topology.TopologyRenderOptions? = null optionalposition: 1
Optional render options.

Returns

A complete HTML page.