Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

View on GitHub Releases Get package
Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

VisualFrame

Namespace ChartForgeX.Rendering
Assembly ChartForgeX
Modifiers sealed

Common title, subtitle, legend and surface configuration.

Inheritance

  • Object
  • VisualFrame

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 1

Constructors

public VisualFrame(String? title = null, String? subtitle = null, Boolean? showLegend = null, ChartLegendPosition? legendPosition = null, Boolean showSurface = false, Boolean transparentBackground = false, TextStyle? titleStyle = null, TextStyle? subtitleStyle = null, TextStyle? legendStyle = null, Int32? legendMaximumRows = null, Double legendMaximumHeightFraction = 0.35, Boolean showCard = false, String? legendTitle = null) #

Creates an immutable frame configuration.

Parameters

title System.String? = null optionalposition: 0
subtitle System.String? = null optionalposition: 1
showLegend System.Boolean? = null optionalposition: 2
legendPosition ChartForgeX.Core.ChartLegendPosition? = null optionalposition: 3
showSurface System.Boolean = false optionalposition: 4
transparentBackground System.Boolean = false optionalposition: 5
titleStyle ChartForgeX.Typography.TextStyle? = null optionalposition: 6
subtitleStyle ChartForgeX.Typography.TextStyle? = null optionalposition: 7
legendStyle ChartForgeX.Typography.TextStyle? = null optionalposition: 8
legendMaximumRows System.Int32? = null optionalposition: 9
legendMaximumHeightFraction System.Double = 0.35 optionalposition: 10
showCard System.Boolean = false optionalposition: 11
legendTitle System.String? = null optionalposition: 12

Properties

public String? Title { get; } #

Gets the title.

public String? Subtitle { get; } #

Gets the subtitle.

public Boolean ShowLegend { get; } #

Gets the requested legend visibility. When omitted, the producer resolves its data-aware default.

public String? LegendTitle { get; } #

Gets an optional measured heading above the legend entries. Null uses the producer's source title.

public ChartLegendPosition LegendPosition { get; } #

Gets the legend placement.

public Boolean ShowSurface { get; } #

Gets whether the content surface is filled.

public Boolean ShowCard { get; } #

Gets whether the complete frame has an elevated card, independently of the content surface.

public Boolean TransparentBackground { get; } #

Gets whether the outer canvas has no background paint, for overlays and embedding.

public TextStyle? TitleStyle { get; } #

Gets a defensive copy of the explicit heading typography.

public TextStyle? SubtitleStyle { get; } #

Gets a defensive copy of the explicit subtitle typography.

public TextStyle? LegendStyle { get; } #

Gets a defensive copy of the explicit legend typography.

public Int32? LegendMaximumRows { get; } #

Gets the additional legend row limit, including any overflow summary row. Null uses only the height budget.

public Double LegendMaximumHeightFraction { get; } #

Gets the maximum fraction of the full viewport height occupied by the legend and its spacing.