SpectreCanvas

Class

For examples and usage details, see the component documentation.

Namespace: RazorConsole.Components

Assembly: RazorConsole.Core

Definition

public class SpectreCanvas : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Name	Type	Description
`SpectreCanvas()`	`Constructor`	—

Name	Type	Description
Appearance
`CanvasHeight`	Int32	Height of the canvas in pixels.
`CanvasWidth`	Int32	Width of the canvas in pixels.
`MaxWidth`	`Nullable<Int32>`	Maximum width of the rendered canvas in console characters. If null, no constraint is applied.
`PixelWidth`	Int32	Width of each pixel when rendered. Default is 2 characters, creating more square-looking pixels.
Other
`Pixels`	`System.ValueTuple<System.Int32,System.Int32,Spectre.Console.Color>[]`	Renders a pixel-based canvas for drawing graphics in the console using Spectre.Console's Canvas renderable.
`Scale`	Boolean	Whether the canvas should automatically scale to fit the console. Default is false.

Name	Type	Description
`BuildRenderTree(RenderTreeBuilder)`()	`Method`	Renders the component to the supplied RenderTreeBuilder.
`Dispose()`	`Method`	—
`OnInitialized()`	`Method`	Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.
`OnParametersSet()`	`Method`	Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.