Project

ChartForgeX

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

View on GitHub Visit Website Releases Get package
Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

ChartMapColorScale

Namespace ChartForgeX.Core

Defines the value-to-color ramp used by region and tile maps.

Inheritance

  • Object
  • ChartMapColorScale

Usage

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

Accepted by parameters

Methods

ColorFor(System.Double value, System.Double sourceMinimum, System.Double sourceMaximum) #

Resolves a value to a color within this scale.

Parameters

value System.Double required
The value to color.
sourceMinimum System.Double required
The minimum source value when the scale has no explicit minimum.
sourceMaximum System.Double required
The maximum source value when the scale has no explicit maximum.

Returns

The interpolated color.

Diverging(ChartForgeX.Primitives.ChartColor lowColor, ChartForgeX.Primitives.ChartColor midpointColor, ChartForgeX.Primitives.ChartColor highColor, System.Nullable{System.Double} midpointValue) #

Creates a three-color diverging map scale.

Parameters

lowColor ChartForgeX.Primitives.ChartColor required
The color for low values.
midpointColor ChartForgeX.Primitives.ChartColor required
The color for the midpoint value.
highColor ChartForgeX.Primitives.ChartColor required
The color for high values.
midpointValue System.Nullable{System.Double} required
An optional midpoint value. When omitted, the midpoint is halfway between the effective minimum and maximum.

Returns

A map color scale.

EffectiveMaximum(System.Double sourceMaximum) #

Gets the effective maximum value used by this scale.

Parameters

sourceMaximum System.Double required
The source data maximum.

Returns

The effective maximum.

EffectiveMidpoint(System.Double sourceMinimum, System.Double sourceMaximum) #

Gets the effective midpoint value used by this scale.

Parameters

sourceMinimum System.Double required
The source data minimum.
sourceMaximum System.Double required
The source data maximum.

Returns

The effective midpoint.

EffectiveMinimum(System.Double sourceMinimum) #

Gets the effective minimum value used by this scale.

Parameters

sourceMinimum System.Double required
The source data minimum.

Returns

The effective minimum.

Sequential(ChartForgeX.Primitives.ChartColor lowColor, ChartForgeX.Primitives.ChartColor highColor) #

Creates a two-color sequential map scale.

Parameters

lowColor ChartForgeX.Primitives.ChartColor required
The color for low values.
highColor ChartForgeX.Primitives.ChartColor required
The color for high values.

Returns

A map color scale.

WithLabels(System.String lowLabel, System.String midpointLabel, System.String highLabel) #

Creates a copy with custom legend labels.

Parameters

lowLabel System.String required
The low-end legend label.
midpointLabel System.String required
The optional midpoint legend label.
highLabel System.String required
The high-end legend label.

Returns

A map color scale.

WithMidpoint(System.Double midpointValue) #

Creates a copy with an explicit diverging midpoint value.

Parameters

midpointValue System.Double required
The midpoint value used by the color scale.

Returns

A map color scale.

WithNoDataColor(ChartForgeX.Primitives.ChartColor noDataColor) #

Creates a copy with a custom no-data color.

Parameters

noDataColor ChartForgeX.Primitives.ChartColor required
The color used for regions without values.

Returns

A map color scale.

WithValueRange(System.Double minimumValue, System.Double maximumValue) #

Creates a copy with explicit color interpolation bounds.

Parameters

minimumValue System.Double required
The minimum value used by the color scale.
maximumValue System.Double required
The maximum value used by the color scale.

Returns

A map color scale.

Properties

LowColor #

Gets the low-value color.

MidpointColor #

Gets the optional midpoint color for diverging map scales.

HighColor #

Gets the high-value color.

MidpointValue #

Gets the optional midpoint value. When omitted, the midpoint is halfway between the effective minimum and maximum.

MinimumValue #

Gets the optional minimum value used for color interpolation.

MaximumValue #

Gets the optional maximum value used for color interpolation.

NoDataColor #

Gets the optional color used for regions with no data.

LowLabel #

Gets the optional low-end legend label.

MidpointLabel #

Gets the optional midpoint legend label.

HighLabel #

Gets the optional high-end legend label.