API Reference

A complete method reference for every public builder, enum, theme, and data type in TerraFluent.Chart.Reporting.

All fluent methods return the builder they were called on, so every call can be chained. Unless noted otherwise, methods validate their arguments and throw ArgumentException / ArgumentOutOfRangeException / ArgumentNullException on invalid input.

Namespaces

• Builders: TerraFluent.Chart.Reporting.Builder
• Models & data types: TerraFluent.Chart.Reporting.Models
• Enums: TerraFluent.Chart.Reporting.Enums

Contents

• ChartBuilder — the fluent entry point
• Series (ChartSeriesBuilder) — adding data series
• SeriesBuilder — per-series styling
• LegendBuilder
• TooltipBuilder
• Credits / branding
• AnimationBuilder
• AnnotationBuilder
• LabelLayoutBuilder
• DataLabelOptions
• DonutCenterOptions
• Enums
• ChartTheme
• ChartColor
• Data-point types
• IChartBuilder

ChartBuilder

TerraFluent.Chart.Reporting.Builder.ChartBuilder

The fluent entry point for building a chart. Create one with ChartBuilder.Create().

Creating a builder

Chart type (default for Add)

These set the fallback type used by the generic Series(s => s.Add(...)) method. Prefer the typed AddLine/AddColumn/… helpers instead.

AsPie() · AsLine() · AsArea() · AsColumn() · AsBar() · AsSpline() · AsScatter() · AsWaterfall() · AsGauge() · AsDataRing() · AsBubble() · AsHeatmap() · AsColumnRange() · AsAreaRange() · AsFunnel() · AsTreemap() · AsDumbbell() · AsStream() · AsGantt() · AsSankey()

Render mode

Dimensions & background

Theme & palette

Title & subtitle

Axes

Plot bands & lines

Legend & tooltip

Credits / branding

The label is shown by default and links to https://terrafluent.dev. Its text and link are fixed (set by the library) so output cannot be re-branded — callers may only show/hide it and choose its corner. It always renders as text; the hyperlink is clickable only when the SVG is embedded inline in a page — rasterised (PNG/JPEG/PDF) or <img>-loaded output keeps the visible text but not the link.

Animation

Series

Export & interactivity (Interactive mode only)

Labels, annotations & advanced layout

Accessibility & localization

Data quality

Render / output

Snapshot & variants

Series (ChartSeriesBuilder)

TerraFluent.Chart.Reporting.Builder.ChartSeriesBuilder

Obtained inside .Series(s => …). Each Add* method appends one series and returns the series builder so multiple series can be chained. Every method accepts an optional Action<SeriesBuilder>? configure to style that series (see SeriesBuilder).

Cartesian series (double[] or double?[])

null values in a double?[] are treated as gaps (see NullGap).

Single-value series

Structured-point series

Computed overlays

Derive a new series from existing data.

SeriesBuilder

TerraFluent.Chart.Reporting.Builder.SeriesBuilder

Passed to the configure lambda of every Add* method to style that one series.

Appearance

Fill (gradient & pattern)

Border

Markers

Thresholds & gaps

Visibility & legend

Pie / donut, labels & centres

Drill-down & insights

LegendBuilder

Legend(l => …)

TooltipBuilder

Tooltip(t => …) (active in Animated and Interactive modes)

Format tokens: {label}, {value}, {series}.

Credits / branding

The chart carries a fixed terrafluent.dev attribution label (bottom-right by default). Its text and link are set by the library and cannot be changed, so output cannot be re-branded. Callers control only visibility and corner:

ChartBuilder.Create()
    .Series(s => s.AddColumn("Sales", data))
    // shown by default; move it or remove it:
    .ShowCredits(CreditsPosition.BottomLeft)
    .RenderToSvg();

// Remove branding entirely:
ChartBuilder.Create()....HideCredits().RenderToSvg();

Renders in all modes (including Static), is script/CSS-free, and survives export as text.

AnimationBuilder

Animation(a => …)

AnnotationBuilder

Annotations(a => …) — coordinates are in data space (category index / axis value).

LabelLayoutBuilder

LabelLayout(l => …) — controls dense X-axis category labels.

DataLabelOptions

Accessed via cfg.DataLabel or cfg.Label(dl => …).

DonutCenterOptions

Accessed via cfg.DonutCenter on pie/donut and data-ring series.

Enums

TerraFluent.Chart.Reporting.Enums

ChartType

Line, Spline, Area, Column, Bar, Pie, Scatter, Waterfall, Gauge, DataRing, Bubble, Heatmap, ColumnRange, AreaRange, Funnel, Treemap, Radar, BoxPlot, ErrorBar, Candlestick, Ohlc, Dumbbell, Stream, Gantt, Sankey, Parliament.

SvgMode

Static · Animated · Interactive.

Easing

Linear · EaseIn · EaseOut · EaseInOut · Bounce · Elastic.

MarkerSymbol

Circle · Square · Diamond · Triangle · TriangleDown.

CreditsPosition

BottomRight (default) · BottomLeft · TopRight · TopLeft.

AxisType

Linear · Logarithmic · DateTime.

Stacking

None (side-by-side) · Normal (cumulative) · Percent (100 %).

GapPolicy

Break (visible gaps, default) · Connect (skip nulls) · Zero (plot nulls at zero).

WarningSeverity

Info = 0 · Warning = 1 · Error = 2.

ChartTheme

TerraFluent.Chart.Reporting.Models.ChartTheme

Built-in presets (static readonly ChartTheme)

Properties

BackgroundColor, PlotBackgroundColor, GridLineColor, AxisLineColor, TextColor, FontFamily, FontScale (default 1.0), Colors (string[]), ModernStyle (bool, default true — see Modern Styling), TooltipBackground, TooltipTextColor, PositiveColor, NegativeColor, AccentColor.

Factory

ChartTheme.Custom(
    string? backgroundColor = null, string? plotBackgroundColor = null,
    string? gridLineColor = null,   string? axisLineColor = null,
    string? textColor = null,       string? fontFamily = null,
    string[]? colors = null,        string? tooltipBackground = null,
    string? tooltipTextColor = null,string? positiveColor = null,
    string? negativeColor = null,   string? accentColor = null);

ChartTheme Clone();   // copy an existing theme (e.g. to tweak FontScale)

ChartColor

TerraFluent.Chart.Reporting.Models.ChartColor

400+ named const string colour constants plus curated palettes and utilities.

Series palette constants

Also includes all standard CSS named colours (Red, SteelBlue, ForestGreen, …), pastel constants (PastelSkyBlue, …), and theme-specific tokens.

Palette arrays (ChartColor.Palette.*)

Default, Dark, Pastel, Monochrome, Ocean, Sunset, Forest, Neon, Minimal, Warm, Arctic, Business, Material, TrafficLight, Accessible, Vivid (each 20 colours), and HighContrast (16 colours).

Utility methods

Data-point types

TerraFluent.Chart.Reporting.Models — inputs for structured series.

IChartBuilder

TerraFluent.Chart.Reporting.Builder.IChartBuilder

An interface mirroring the full ChartBuilder surface. Depend on IChartBuilder in your services for testable, decoupled code, and register the concrete builder in DI:

services.AddScoped<IChartBuilder>(_ => ChartBuilder.Create());

All chaining, configuration, and render methods listed above are available on the interface. The async render methods (RenderToStreamAsync, RenderToFileAsync, RenderToHtmlFileAsync) are present only on net6.0 and newer targets.

See also: Getting Started · Chart Types · Themes & Styling · Advanced Features · Troubleshooting & FAQ

View this page's source on GitHub →