CodeGlyphX logo
CodeGlyphX

API Reference

Class

MatrixSvgRenderer

Namespace CodeGlyphX.Rendering.Svg
Assembly CodeGlyphX
Modifiers static

Renders generic 2D matrices to SVG.

Inheritance

  • Object
  • MatrixSvgRenderer

Methods

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

Renders the matrix to an SVG string.

Parameters

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

Renders the matrix to an SVG file.

Parameters

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

Returns

The output file path.

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

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

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Svg.MatrixSvgRenderOptions 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, MatrixSvgRenderOptions opts, Stream stream) #
Returns: Void

Renders the matrix to an SVG stream.

Parameters

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