Skip to content
ChartForgeX

API Reference

Class

HtmlInteractiveChartRenderer

Edit on GitHub
Namespace ChartForgeX.Interactivity.Html
Assembly ChartForgeX.Interactivity.Html
Source HtmlInteractiveChartRenderer.cs:20
Modifiers sealed

Renders a ChartForgeX chart as a self-contained interactive HTML document.

Inheritance

  • Object
  • HtmlInteractiveChartRenderer

Constructors

public HtmlInteractiveChartRenderer() #

Methods

public static String BuildFragmentStyle() #
HtmlInteractiveChartRenderer.cs:118
Returns: String

Builds the stylesheet used by embeddable interactive chart fragments.

Returns

CSS ready to register once in a host document.

public static String BuildInteractionScript() #
HtmlInteractiveChartRenderer.cs:124
Returns: String

Builds the JavaScript runtime used by embeddable interactive chart fragments.

Returns

JavaScript ready to register once in a host document.

public HtmlChartSection PrepareSection(Chart chart, ChartXViewport? viewport = null, Action<HtmlChartInteractionOptions>? configure = null) #
HtmlInteractiveChartRenderer.cs:107
Returns: HtmlChartSection

Prepares an asset-free interactive section and its matching detached native scene once.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to prepare.
viewport ChartForgeX.Core.ChartXViewport? = null optionalposition: 1
An optional explicit numeric X window for supported vertical Line and StepLine charts. Null prepares the full domain, including when resetting a previous viewport.
configure System.Action<ChartForgeX.Interactivity.Html.HtmlChartInteractionOptions>? = null optionalposition: 2
An optional callback configuring the HTML interaction adapter.

Returns

The section markup and the prepared scene used to render it.

Exceptions

  • ArgumentNullException – The chart is null.
  • NotSupportedException – An explicit viewport is requested for an unsupported chart.
  • ArgumentOutOfRangeException – An explicit viewport extends outside the full X domain or cannot be mapped.
  • InvalidOperationException – An explicit viewport is requested without observations or a usable plot.
RenderFragment 2 overloads
public String RenderFragment(Chart chart) #
HtmlInteractiveChartRenderer.cs:48
Returns: String

Renders the specified chart to a self-contained embeddable interactive HTML fragment.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to render.

Returns

An embeddable interactive HTML fragment.

public String RenderFragment(Chart chart, Action<HtmlChartInteractionOptions>? configure) #
HtmlInteractiveChartRenderer.cs:57
Returns: String

Renders the specified chart to a self-contained embeddable interactive HTML fragment.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to render.
configure System.Action<ChartForgeX.Interactivity.Html.HtmlChartInteractionOptions>? requiredposition: 1
An optional configuration callback for the HTML interaction adapter.

Returns

An embeddable interactive HTML fragment.

RenderFragmentWithoutAssets 2 overloads
public String RenderFragmentWithoutAssets(Chart chart) #
HtmlInteractiveChartRenderer.cs:81
Returns: String

Renders the specified chart to an embeddable interactive HTML fragment without stylesheet or script assets.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to render.

Returns

An embeddable interactive HTML fragment that expects the caller to register interactive chart assets.

public String RenderFragmentWithoutAssets(Chart chart, Action<HtmlChartInteractionOptions>? configure) #
HtmlInteractiveChartRenderer.cs:90
Returns: String

Renders the specified chart to an embeddable interactive HTML fragment without stylesheet or script assets.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to render.
configure System.Action<ChartForgeX.Interactivity.Html.HtmlChartInteractionOptions>? requiredposition: 1
An optional configuration callback for the HTML interaction adapter.

Returns

An embeddable interactive HTML fragment that expects the caller to register interactive chart assets.

RenderPage 2 overloads
public String RenderPage(Chart chart) #
HtmlInteractiveChartRenderer.cs:20
Returns: String

Renders the specified chart to a complete interactive HTML document.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to render.

Returns

A complete HTML document.

public String RenderPage(Chart chart, Action<HtmlChartInteractionOptions>? configure) #
HtmlInteractiveChartRenderer.cs:29
Returns: String

Renders the specified chart to a complete interactive HTML document.

Parameters

chart ChartForgeX.Core.Chart requiredposition: 0
The chart to render.
configure System.Action<ChartForgeX.Interactivity.Html.HtmlChartInteractionOptions>? requiredposition: 1
An optional configuration callback for the HTML interaction adapter.

Returns

A complete HTML document.