Interface IEncodedSymbol

Namespace

TwBlazor.Services.Encoding

Assembly

TwBlazor.dll

An encoded symbol: a grid of dark and light modules that a scanner reads, such as a QrMatrix (a square grid) or a Barcode (a single row of bars).

public interface IEncodedSymbol

Extension Methods

SymbolSvg.GetSvgPath(IEncodedSymbol, int?, int)

SymbolSvg.GetSvgViewBox(IEncodedSymbol, int?, int)

SymbolSvg.ToSvg(IEncodedSymbol, SymbolSvgOptions?)

SymbolSvg.ToSvgDataUri(IEncodedSymbol, SymbolSvgOptions?)

Remarks

Every renderer works from this grid, so one renderer draws every kind of symbol. Coordinates start at the top-left, with x running right and y running down. The grid does not include the quiet zone.

Properties

Height

Gets the number of module rows; 1 for a one-dimensional barcode, whose bars are stretched to any height.

int Height { get; }

Property Value

int

this[int, int]

Gets whether the module at a position is dark.

bool this[int x, int y] { get; }

Parameters

x int

The column, from 0 at the left.

y int

The row, from 0 at the top.

Property Value

bool

true for a dark module; false for a light one or a position outside the grid.

QuietZone

Gets the light margin, in modules, the symbology needs around the symbol so scanners can find it. A one-dimensional barcode only needs it on the left and right.

int QuietZone { get; }

Property Value

int

Width

Gets the number of module columns.

int Width { get; }

Property Value

int