Skip to content
ChartForgeX

API Reference

Class

VisualBlock`1

Namespace ChartForgeX.VisualBlocks
Assembly ChartForgeX
Modifiers abstract

Base class for fluent visual block models.

Inheritance

  • Object
  • VisualBlock`1

Type Parameters

TSelf
The concrete visual block type.

Methods

public TSelf ConfigureTheme(Action<VisualThemeBuilder> configure) #
Returns: TSelf

Atomically replaces the shared theme using an isolated configuration builder.

Parameters

configure System.Action<ChartForgeX.Themes.VisualThemeBuilder> requiredposition: 0
public virtual RgbaImage RenderRgba() #
Returns: RgbaImage

Renders the producer-owned static pixels.

public virtual String RenderSvg(String idScope) #
Returns: String

Renders the producer-owned static SVG with an embedding identity scope.

Parameters

idScope System.String requiredposition: 0
public TSelf WithCard(Boolean enabled = true) #
Returns: TSelf

Sets whether the outer card surface should be rendered.

Parameters

enabled System.Boolean = true optionalposition: 0
public TSelf WithHostFrame(Boolean hostOwnsFrame = true) #
Returns: TSelf

Lets the embedding host own the surface and removes outer padding.

Parameters

hostOwnsFrame System.Boolean = true optionalposition: 0
WithPadding 2 overloads
public TSelf WithPadding(Double padding) #
Returns: TSelf

Sets uniform inner content padding.

Parameters

padding System.Double requiredposition: 0
public TSelf WithPadding(Double left, Double top, Double right, Double bottom) #
Returns: TSelf

Sets the inner content padding.

Parameters

left System.Double requiredposition: 0
top System.Double requiredposition: 1
right System.Double requiredposition: 2
bottom System.Double requiredposition: 3
public TSelf WithPngOutputScale(Int32 scale) #
Returns: TSelf

Sets the output pixel multiplier used by PNG exports.

Parameters

scale System.Int32 requiredposition: 0
public TSelf WithSize(Int32 width, Int32 height) #
Returns: TSelf

Sets the rendered block size.

Parameters

width System.Int32 requiredposition: 0
height System.Int32 requiredposition: 1
public TSelf WithSubtitle(String subtitle) #
Returns: TSelf

Sets the block subtitle.

Parameters

subtitle System.String requiredposition: 0
public TSelf WithTheme(VisualTheme theme, VisualThemeMode? mode = null) #
Returns: TSelf

Sets the visual theme.

Parameters

theme ChartForgeX.Themes.VisualTheme requiredposition: 0
mode ChartForgeX.Themes.VisualThemeMode? = null optionalposition: 1
public TSelf WithThemeMode(VisualThemeMode mode) #
Returns: TSelf

Sets the light or dark mode without changing the shared theme.

Parameters

mode ChartForgeX.Themes.VisualThemeMode requiredposition: 0
public TSelf WithTitle(String title) #
Returns: TSelf

Sets the block title.

Parameters

title System.String requiredposition: 0
public TSelf WithTransparentBackground(Boolean enabled = true) #
Returns: TSelf

Sets whether the full background should stay transparent.

Parameters

enabled System.Boolean = true optionalposition: 0

Properties

public String Title { get; set; } #

Gets or sets the block title.

public String Subtitle { get; set; } #

Gets or sets the block subtitle.

public VisualBlockOptions Options { get; } #

Gets shared rendering options.

public virtual String AccessibleName { get; } #

Gets a concise accessibility label.