ChartJs

Initializes a new instance of the ChartJs class.

Adds a point to the primary dataset and switches the chart to the area style.

Parameters

label System.String requiredposition: 0

Label for the point.

value System.Double requiredposition: 1

Value plotted for the area chart.

Returns

The current ChartJs instance.

Adds a bar value using the simplified API and switches the chart to the bar type.

Parameters

label System.String requiredposition: 0

Label for the bar.

value System.Double requiredposition: 1

Height of the bar.

Returns

The current ChartJs instance.

Adds a bubble point for bubble charts.

Parameters

x System.Double requiredposition: 0

y System.Double requiredposition: 1

radius System.Double requiredposition: 2

Adds a column value; an alias for Double) kept for readability.

Parameters

label System.String requiredposition: 0

Label for the column.

value System.Double requiredposition: 1

Height of the column.

Returns

The current ChartJs instance.

Adds a numeric data point with an associated label.

Parameters

label System.String requiredposition: 0

Label for the value.

value System.Double requiredposition: 1

Numeric value.

Returns

The current ChartJs instance.

Adds a gauge-v3 dataset (for layered gauges like clocks) with strongly-typed options.

Parameters

label System.String requiredposition: 0

stops System.Collections.Generic.IEnumerable{System.Double} requiredposition: 1

value System.Double requiredposition: 2

configure System.Action{HtmlForgeX.ChartJsGaugeV3DatasetOptions} = null optionalposition: 3

Adds a label to the chart.

Parameters

label System.String requiredposition: 0

Label to add.

Returns

The current ChartJs instance.

Adds multiple labels to the chart.

Parameters

labels System.String[] requiredposition: 0

Labels to add.

Returns

The current ChartJs instance.

Adds a point to the primary dataset and switches the chart to the line type.

Parameters

label System.String requiredposition: 0

Label for the point.

value System.Double requiredposition: 1

Value plotted on the line.

Returns

The current ChartJs instance.

Adds a point for scatter charts.

Parameters

x System.Double requiredposition: 0

y System.Double requiredposition: 1

Adds an additional Sankey dataset (useful for side-by-side Sankey visualizations).

Parameters

label System.String requiredposition: 0

configure System.Action{HtmlForgeX.ChartJsSankeyDatasetOptions} requiredposition: 1

Adds/extends a stacked bar series and aligns categories automatically.

Parameters

seriesName System.String requiredposition: 0

points System.ValueTuple{System.String,System.Double}[] requiredposition: 1

Convenience builder for an area chart (line with fill). Sets the chart type to Line and enables default dataset fill for simple API and AddDataset overloads.

Shortcut for calling ChartJsType) with Bar.

Returns

The current ChartJs instance.

Sets the Y-axis to begin at zero.

Parameters

enabled System.Boolean = true optionalposition: 0

Shortcut for calling ChartJsType) with Bubble.

Returns

The current ChartJs instance.

Simple horizontal bullet chart (performance bar) using stacked bars. Ranges are drawn as a background stack; the actual value overlays as a thin bar. No external plugins required.

Parameters

value System.Double requiredposition: 0

target System.Double requiredposition: 1

min System.Double requiredposition: 2

max System.Double requiredposition: 3

configure System.Action{HtmlForgeX.ChartJsBulletOptions} = null optionalposition: 4

Adds a centered label inside circular charts (doughnut/pie/gauge) using the Chart.js Annotation plugin. Automatically registers the plugin library.

Parameters

text System.String requiredposition: 0

Text to display.

fontSize System.Int32 = 26 optionalposition: 1

Font size in px.

color System.String = "#111" optionalposition: 2

Text color.

backgroundColor System.String = null optionalposition: 3

Background behind the text (transparent by default).

padding System.Int32 = 6 optionalposition: 4

Padding around text.

Configures chart options with full access.

Parameters

configure System.Action{HtmlForgeX.ChartJsOptions} requiredposition: 0

Shortcut for calling ChartJsType) with Doughnut.

Returns

The current ChartJs instance.

Enables interactivity for choropleth/bubble maps: tooltips and click output element.

Parameters

configure System.Action{HtmlForgeX.ChartJsGeoInteractivity} requiredposition: 0

Convenience: make the chart fill its container width while letting height be driven by content. Sets responsive=true and maintainAspectRatio=false when enabled.

Parameters

enabled System.Boolean = true optionalposition: 0

Configures this chart as a semi-circular gauge using a doughnut with a value vs. remainder segment. No external plugins required.

Parameters

value System.Double requiredposition: 0

Current value.

min System.Double requiredposition: 1

Minimum value.

max System.Double requiredposition: 2

Maximum value.

configure System.Action{HtmlForgeX.ChartJsGaugeOptions} = null optionalposition: 3

Optional extra styling (colors, cutout, angles).

Adds radial tick marks (dial ticks) drawn via a lightweight plugin. Works with both ring and wedge gauges.

Parameters

configure System.Action{HtmlForgeX.ChartJsGaugeTicksOptions} = null optionalposition: 0

Applies a predefined style for gauge-v3 (angles/cutout/needle tweaks).

Parameters

style HtmlForgeX.ChartJsGaugeV3Style requiredposition: 0

Configures a semi-circular gauge with a needle drawn via an optional plugin. The colored arc is built from bands; the needle indicates value.

Parameters

value System.Double requiredposition: 0

Current value.

min System.Double requiredposition: 1

Minimum value.

max System.Double requiredposition: 2

Maximum value.

configure System.Action{HtmlForgeX.ChartJsNeedleGaugeOptions} = null optionalposition: 3

Optional extra styling and band configuration.

Configures layout/grid options, providing parity with ApexCharts.Grid.

Parameters

configure System.Action{HtmlForgeX.ChartJsLayout} requiredposition: 0

Shortcut for calling ChartJsType) with Line.

Returns

The current ChartJs instance.

Sets the maintainAspectRatio option directly.

Parameters

value System.Boolean requiredposition: 0

Configures mixed chart mode. Root type is omitted and each dataset can specify its own type. Use dataset.SetType(ChartJsType.Line|Bar|...) to mix series.

Disables animations.

Adds a label anchored at the chart center with pixel offsets (xAdjust, yAdjust). Positive xAdjust moves right; positive yAdjust moves down.

Parameters

key System.String requiredposition: 0

text System.String requiredposition: 1

fontSize System.Int32 = 26 optionalposition: 2

color System.String = "#111" optionalposition: 3

backgroundColor System.String = null optionalposition: 4

padding System.Int32 = 6 optionalposition: 5

xAdjust System.Int32 = 0 optionalposition: 6

yAdjust System.Int32 = 0 optionalposition: 7

Shortcut for calling ChartJsType) with Pie.

Returns

The current ChartJs instance.

Configures plugins with fluent API.

Parameters

configure System.Action{HtmlForgeX.ChartJsPlugins} requiredposition: 0

Alias for PolarArea().

Shortcut for calling ChartJsType) with PolarArea.

Returns

The current ChartJs instance.

Shortcut for calling ChartJsType) with Radar.

Returns

The current ChartJs instance.

Configures the R-axis (for polar charts) with fluent API.

Parameters

configure System.Action{HtmlForgeX.ChartJsAxis} requiredposition: 0

Sets the R-axis range for polar charts.

Parameters

min System.Nullable{System.Double} = null optionalposition: 0

max System.Nullable{System.Double} = null optionalposition: 1

Registers the Chart.js library with the current document.

Sets the responsive behavior.

Parameters

responsive System.Boolean = true optionalposition: 0

maintainAspectRatio System.Boolean = true optionalposition: 1

Provides the fluent Settings(...) surface for building Sankey datasets while keeping the root surface minimal.

Parameters

configure System.Action{HtmlForgeX.ChartJsSankeySettings} requiredposition: 0

Configures scales with fluent API.

Parameters

configure System.Action{HtmlForgeX.ChartJsScales} requiredposition: 0

Shortcut for calling ChartJsType) with Scatter.

Returns

The current ChartJs instance.

Convenience for a scatter chart rendered as an area (connect points and fill under line).

Enable segment labels plugin and configure appearance.

Parameters

configure System.Action{HtmlForgeX.ChartJsSegmentLabelsOptions} requiredposition: 0

Sets the chart type.

Parameters

type HtmlForgeX.ChartJsType requiredposition: 0

Chart type.

Returns

The current ChartJs instance.

Sets the canvas dimensions.

Parameters

width System.String = null optionalposition: 0

height System.String = null optionalposition: 1

Convenience builder for a solid wedge gauge (half or full). Sets cutout to 0, wires default bands, adds radial ticks with labels, and an optional center label.

Parameters

value System.Double requiredposition: 0

min System.Double requiredposition: 1

max System.Double requiredposition: 2

semi System.Boolean = true optionalposition: 3

centerLabel System.String = null optionalposition: 4

centerLabelColor System.String = "#111" optionalposition: 5

centerLabelFont System.Int32 = 20 optionalposition: 6

configure System.Action{HtmlForgeX.ChartJsGaugeOptions} = null optionalposition: 7

configureTicks System.Action{HtmlForgeX.ChartJsGaugeTicksOptions} = null optionalposition: 8

Convenience builder for a speedometer gauge (semi by default). Wires needle, colored bands, ticks with numeric labels, and a center label showing the value + units.

Parameters

value System.Double requiredposition: 0

min System.Double requiredposition: 1

max System.Double requiredposition: 2

units System.String = "km/h" optionalposition: 3

fullDial System.Boolean = false optionalposition: 4

configure System.Action{HtmlForgeX.ChartJsNeedleGaugeOptions} = null optionalposition: 5

configureTicks System.Action{HtmlForgeX.ChartJsGaugeTicksOptions} = null optionalposition: 6

Configures the chart as stacked (for bar and line charts).

Parameters

enabled System.Boolean = true optionalposition: 0

Generates the HTML required to render the chart.

Returns

The HTML markup.

Convenience: US states choropleth using us-atlas states topology and albersUsa projection.

Parameters

configure System.Action{HtmlForgeX.ChartJsGeoWorldOptions} = null optionalposition: 0

Enables value clamping/rounding for this chart.

Parameters

configure System.Action{HtmlForgeX.ChartValueClampingOptions} requiredposition: 0

10x10 waffle chart using a Bubble grid (no plugin required). Each cell is a circle; filled cells use a strong color; remainder uses a neutral.

Parameters

percent System.Double requiredposition: 0

0..100 filled cells.

filledColor System.String = "#206bc4" optionalposition: 1

Color for filled cells.

emptyColor System.String = "#e9ecef" optionalposition: 2

Color for empty cells.

Bubble/point map using chartjs-chart-geo 'bubbleMap' controller. Provide points with latitude/longitude and value.

Parameters

configure System.Action{HtmlForgeX.ChartJsGeoBubbleOptions} requiredposition: 0

Configures a world choropleth using chartjs-chart-geo. Data is generated client-side from TopoJSON. Optionally provide value-by-name mapping to color countries.

Parameters

configure System.Action{HtmlForgeX.ChartJsGeoWorldOptions} = null optionalposition: 0

Configures the X-axis with fluent API.

Parameters

configure System.Action{HtmlForgeX.ChartJsAxis} requiredposition: 0

Sets the X-axis range.

Parameters

min System.Nullable{System.Double} = null optionalposition: 0

max System.Nullable{System.Double} = null optionalposition: 1

Sets the X-axis title.

Parameters

text System.String requiredposition: 0

display System.Boolean = true optionalposition: 1

Configures the Y-axis with fluent API.

Parameters

configure System.Action{HtmlForgeX.ChartJsAxis} requiredposition: 0

Sets the Y-axis to NOT begin at zero (allows floating scale).

Sets the Y-axis range.

Parameters

min System.Nullable{System.Double} = null optionalposition: 0

max System.Nullable{System.Double} = null optionalposition: 1

Sets the Y-axis title.

Parameters

text System.String requiredposition: 0

display System.Boolean = true optionalposition: 1