Project

ChartForgeX

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

Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

ChartOptions

Namespace ChartForgeX.Core

Defines renderer-independent options for a chart.

Inheritance

  • Object
  • ChartOptions

Methods

GetTextStyle(ChartForgeX.Core.ChartTextRole arg1) #

Gets the text style for the requested role.

Parameters

arg1 ChartForgeX.Core.ChartTextRole required

Properties

XAxis #

Gets the primary horizontal axis.

YAxis #

Gets the primary vertical axis.

SecondaryYAxis #

Gets the secondary vertical axis.

ShowAxes #

Gets or sets a value indicating whether axes, labels, and titles are rendered.

ShowXAxis #

Gets or sets legacy x-axis visibility through XAxis.

ShowYAxis #

Gets or sets legacy y-axis visibility through YAxis.

ShowAxisLines #

Gets or sets axis-rule visibility for every configured axis.

TickCount #

Gets or sets the shared legacy tick count for every axis.

XAxisLabelDensity #

Gets or sets x-axis label density.

YAxisLabelDensity #

Gets or sets y-axis label density.

XAxisLabelAngle #

Gets or sets x-axis label rotation.

XAxisMinimum #

Gets or sets the explicit x-axis minimum.

XAxisMaximum #

Gets or sets the explicit x-axis maximum.

YAxisMinimum #

Gets or sets the explicit y-axis minimum.

YAxisMaximum #

Gets or sets the explicit y-axis maximum.

SecondaryYAxisMinimum #

Gets or sets the explicit secondary y-axis minimum.

SecondaryYAxisMaximum #

Gets or sets the explicit secondary y-axis maximum.

SecondaryYAxisValueFormatter #

Gets or sets the secondary y-axis label formatter.

XAxisValueFormatter #

Gets or sets the x-axis label formatter.

XAxisLabels #

Gets explicit x-axis labels.

XAxisLabelHighlights #

Gets x-axis tick label highlight colors keyed by axis value.

BarMode #

Gets or sets how multiple bar series are arranged within each category.

BarStyle #

Gets or sets the visual treatment used by bar and horizontal-bar renderers.

BarVisualStyle #

Gets or sets reusable visual tokens for bar and horizontal-bar renderers.

GridLineStyle #

Gets or sets reusable visual tokens for cartesian grid and guide lines.

ShowStackTotals #

Gets or sets a value indicating whether stacked bar totals are rendered above each category.

Size #

Gets or sets the rendered chart size in pixels.

Padding #

Gets or sets the chart padding around the plot area.

Theme #

Gets or sets the visual theme used by renderers.

PngFontPath #

Gets or sets the preferred TrueType font file or TrueType collection used by the PNG renderer.

PngFontFaceName #

Gets or sets the optional family, subfamily, full, or PostScript face name used when selecting a PNG font.

PngFontCollectionIndex #

Gets or sets the optional face index used when PngFontPath points to a TrueType collection.

PngSupersamplingScale #

Gets or sets the internal supersampling scale used by the PNG renderer.

PngOutputScale #

Gets or sets the output pixel multiplier used by the PNG renderer.

ShowLegend #

Gets or sets a value indicating whether the legend is rendered.

ShowPointLegend #

Gets or sets a value indicating whether capable legends should list individual points instead of series.

LegendPosition #

Gets or sets where the legend is placed relative to the plot area.

ShowHeader #

Gets or sets a value indicating whether the title and subtitle are rendered.

ShowCard #

Gets or sets a value indicating whether the outer card surface is rendered.

ShowPlotBackground #

Gets or sets a value indicating whether the plot background surface is rendered.

ShowGrid #

Gets or sets a value indicating whether grid lines are rendered.

TransparentBackground #

Gets or sets a value indicating whether the chart background should be transparent.

ShowDataLabels #

Gets or sets a value indicating whether point and bar values are rendered as labels.

GanttToday #

Gets or sets the optional Gantt current-date marker as an OLE Automation date or numeric schedule value.

HeatmapScale #

Gets or sets how heatmap values are converted into cell colors.

ShowHeatmapScale #

Gets or sets a value indicating whether heatmap scale legends are rendered.

ShowHeatmapColumnLabels #

Gets or sets a value indicating whether heatmap column labels are rendered.

PictorialShape #

Gets or sets the built-in symbol shape used by pictorial charts.

PictorialColumns #

Gets or sets the number of repeated symbols used per pictorial chart row.

PictorialMaximum #

Gets or sets the optional scale maximum used by pictorial chart rows.

PictorialValuePerSymbol #

Gets or sets the data value represented by one full pictorial symbol.

ShowPictorialValues #

Gets or sets a value indicating whether numeric value labels are rendered for pictorial rows.

PictorialSymbolScale #

Gets or sets the relative pictorial symbol size inside each symbol slot.

PictorialEmptyOpacity #

Gets or sets the opacity used by unfilled pictorial symbols.

ProgressMaximum #

Gets or sets the maximum value used by progress-bar charts.

ShowProgressValues #

Gets or sets a value indicating whether numeric value labels are rendered for progress-bar rows.

ShowProgressHandles #

Gets or sets a value indicating whether progress-bar rows render slider handles.

ProgressBarThicknessRatio #

Gets or sets the progress-bar thickness as a ratio of each row height.

ProgressTrackOpacity #

Gets or sets the opacity used by progress-bar tracks.

ShowDonutCenterLabel #

Gets or sets a value indicating whether donut charts render the center total and series label.

DonutInnerRadiusRatio #

Gets or sets the ratio of the donut hole radius to the outer radius.

DonutCenterValue #

Gets or sets optional custom primary text rendered in the center of donut charts.

DonutCenterLabel #

Gets or sets optional custom secondary text rendered in the center of donut charts.

ShowRadialBarCenterLabel #

Gets or sets a value indicating whether radial-bar charts render the center average and series label.

CircleRadiusScale #

Gets or sets the relative radius used by circle charts.

CircleStrokeScale #

Gets or sets the relative stroke thickness used by circle charts.

RadialBarRadiusScale #

Gets or sets the relative outer radius used by radial-bar charts.

RadialBarStrokeScale #

Gets or sets the relative stroke thickness used by radial-bar charts.

ShowCircleStatusLabel #

Gets or sets a value indicating whether circle charts render the status marker and status label.

PictorialSvgPathData #

Gets or sets optional SVG path data used as the pictorial symbol in SVG and HTML output.

PictorialSvgPathViewBox #

Gets or sets the viewBox used to scale PictorialSvgPathData.

PictorialPngFallbackShape #

Gets or sets the built-in shape used by PNG output when PictorialSvgPathData is configured.

WordCloudMinFontSize #

Gets or sets the smallest font size used by word cloud terms.

WordCloudMaxFontSize #

Gets or sets the largest font size used by word cloud terms.

WordCloudAngles #

Gets or sets the deterministic rotation angles used by word cloud terms.

WordCloudMaximumTerms #

Gets or sets the optional maximum number of positive-weight terms rendered in a word cloud.

WordCloudDensity #

Gets or sets the word cloud packing density from 0.5 to 2.0.

ValueFormatter #

Gets or sets a formatter used for y-axis ticks, data labels, stack totals, and donut totals.

IsSparkline #

Gets or sets a value indicating whether the chart is rendered as a compact sparkline.

DataLabelPlacement #

Gets or sets the preferred data-label placement for capable renderers.

DataLabelConnectorColor #

Gets or sets an optional override color for data-label connector lines. Pie and donut callouts use the matching slice color when this is null.

DataLabelConnectorOpacity #

Gets or sets the opacity used by data-label connector lines.

DataLabelConnectorStrokeWidth #

Gets or sets the stroke width used by data-label connector lines.

DataLabelConnectorStyle #

Gets or sets the connector line shape used by outside and side data labels.

PieSliceLabelContent #

Gets or sets the text rendered for pie and donut slice data labels.

PieSliceLabelFormatter #

Gets or sets a custom formatter for pie and donut slice data labels.

PieOutsideLabelDistanceRatio #

Gets or sets the side-lane distance for outside pie and donut labels as a ratio of the outer radius.

HeatmapCellGap #

Gets or sets an optional heatmap cell gap in pixels.

HeatmapCellRadius #

Gets or sets an optional heatmap cell corner radius in pixels.

HeatmapValueTextMode #

Gets or sets when heatmap cell values are rendered as text.

LineVisualStyle #

Gets or sets reusable visual tokens for line, area boundary, trend, and slope strokes.

MapViewport #

Gets or sets the longitude/latitude window rendered by dotted map charts.

RegionMapDefinition #

Gets or sets the region-map geometry used by generic region map charts.

RegionMapBounds #

Gets or sets optional source coordinate bounds used to frame region maps.

MapBaseLayers #

Gets the non-data geography layers rendered behind region maps.

MapOverlayLayers #

Gets the non-data geography layers rendered above region maps.

TileMapDefinition #

Gets or sets the tile-map geometry used by tile map charts.

MapConnectors #

Gets the connector lines rendered on capable map charts.

ShowMapLabels #

Gets or sets a value indicating whether region labels are rendered on map charts.

ShowMapScaleLegend #

Gets or sets a value indicating whether map scale legends are rendered.

MapScaleLegendPosition #

Gets or sets where map scale legends are rendered.

ShowMapSurface #

Gets or sets a value indicating whether map charts render their own background surface.

MapColorScale #

Gets or sets the optional color scale used by region and tile maps.

MapRegionStrokeColor #

Gets or sets the optional stroke color used for data regions.

MapRegionStrokeWidth #

Gets or sets the stroke width used for data regions.

TitleStyle #

Gets the text style used for chart titles.

SubtitleStyle #

Gets the text style used for chart subtitles.

AxisTitleStyle #

Gets the text style used for axis titles.

TickLabelStyle #

Gets the text style used for axis tick and category labels.

LegendStyle #

Gets the text style used for legend labels.

DataLabelStyle #

Gets the text style used for data labels.