HtmlForgeX

API Reference

Class

ChartValueClampingOptions

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Options controlling value clamping and rounding for charts.

Inheritance

  • Object
  • ChartValueClampingOptions

Constructors

public ChartValueClampingOptions() #

Methods

public ChartValueClampingOptions AutoDecimalsIf(Boolean enable = true) #
Returns: ChartValueClampingOptions

Enable automatic decimal selection.

Parameters

enable System.Boolean = true optionalposition: 0
public ChartValueClampingOptions Axes(Boolean x = false, Boolean y = true, Boolean z = false) #
Returns: ChartValueClampingOptions

Apply to specified axes.

Parameters

x System.Boolean = false optionalposition: 0
y System.Boolean = true optionalposition: 1
z System.Boolean = false optionalposition: 2
public ChartValueClampingOptions Clone() #
Returns: ChartValueClampingOptions

Create a shallow copy of these options.

public ChartValueClampingOptions Decimals(Int32 decimals) #
Returns: ChartValueClampingOptions

Use a fixed number of decimals.

Parameters

decimals System.Int32 requiredposition: 0
public ChartValueClampingOptions Enable(Boolean enabled = true) #
Returns: ChartValueClampingOptions

Enable or disable clamping/rounding.

Parameters

enabled System.Boolean = true optionalposition: 0
public ChartValueClampResult Evaluate(IEnumerable<Double> values) #
Returns: ChartValueClampResult

Compute clamping/rounding summary for a set of values.

Parameters

values System.Collections.Generic.IEnumerable{System.Double} requiredposition: 0
public ChartValueClampingOptions OutlierCap(Boolean enable = true, Double percentile = 0.95, Double ratio = 5) #
Returns: ChartValueClampingOptions

Enable percentile-based outlier capping.

Parameters

enable System.Boolean = true optionalposition: 0
percentile System.Double = 0.95 optionalposition: 1
ratio System.Double = 5 optionalposition: 2

Properties

public Boolean Enabled { get; set; } #

Enable clamping/rounding.

public Boolean ApplyToY { get; set; } #

Apply to Y values (default true).

public Boolean ApplyToX { get; set; } #

Apply to X values (default false).

public Boolean ApplyToZ { get; set; } #

Apply to Z values (default false).

public Boolean AutoDecimals { get; set; } #

Automatically choose decimal precision based on magnitude.

public Nullable<Int32> FixedDecimals { get; set; } #

Override decimal precision (disables auto when set).

public Boolean CapOutliers { get; set; } #

Enable outlier cap detection (percentile-based).

public Double OutlierPercentile { get; set; } #

Percentile used for outlier cap (default 95%).

public Double OutlierRatio { get; set; } #

Outlier ratio threshold (max / pXX) required to enable cap.

public Int32 MinSamplesForOutlierCap { get; set; } #

Minimum sample count required before outlier capping is considered.

public Boolean ApplyAxisMax { get; set; } #

Apply axis max when outlier capping is triggered.

public Boolean OverrideAxisMax { get; set; } #

Override existing axis max when applying outlier cap.

public Boolean ClampValuesToMax { get; set; } #

Clamp data values to the capped max instead of only adjusting axis.