CodeGlyphX logo
CodeGlyphX

API Reference

Class

MatrixHtmlRenderer

Namespace CodeGlyphX.Rendering.Html
Assembly CodeGlyphX
Modifiers static

Renders generic 2D matrices to HTML (table-based).

Inheritance

  • Object
  • MatrixHtmlRenderer

Methods

public static String Render(BitMatrix modules, MatrixHtmlRenderOptions opts) #
Returns: String

Renders the matrix to an HTML table.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
opts CodeGlyphX.Rendering.Html.MatrixHtmlRenderOptions requiredposition: 1
RenderToFile 2 overloads
public static String RenderToFile(BitMatrix modules, MatrixHtmlRenderOptions opts, String path) #
Returns: String

Renders the matrix to an HTML file.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Html.MatrixHtmlRenderOptions requiredposition: 1
Rendering options.
path System.String requiredposition: 2
Output file path.

Returns

The output file path.

public static String RenderToFile(BitMatrix modules, MatrixHtmlRenderOptions opts, String directory, String fileName) #
Returns: String

Renders the matrix to an HTML file under the specified directory.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Html.MatrixHtmlRenderOptions requiredposition: 1
Rendering options.
directory System.String requiredposition: 2
Output directory.
fileName System.String requiredposition: 3
Output file name.

Returns

The output file path.

public static Void RenderToStream(BitMatrix modules, MatrixHtmlRenderOptions opts, Stream stream) #
Returns: Void

Renders the matrix to an HTML stream.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Html.MatrixHtmlRenderOptions requiredposition: 1
Rendering options.
stream System.IO.Stream requiredposition: 2
Target stream.