Table of Contents

Class PropertyChartEngineDonut2D

Namespace
combit.Reporting.Dom
Assembly
combit.ListLabel31.CrossPlatform.dll

Provides data consumption logic for the 2D Donut chart engine, including axis value evaluation and data cache management.

public class PropertyChartEngineDonut2D : PropertyChartEnginePieDonutBase
Inheritance
PropertyChartEngineDonut2D
Inherited Members

Constructors

PropertyChartEngineDonut2D(PropertyChartEngineBase)

Wraps an existing engine DOM item and (re)initializes defaults when required.

public PropertyChartEngineDonut2D(PropertyChartEngineBase item)

Parameters

item PropertyChartEngineBase

Properties

InnerRadiusPercentage

Gets or sets inner radius percentage of the donut.

public string InnerRadiusPercentage { get; set; }

Property Value

string

YAxis

Gets the value axis for the donut chart.

[JsonInclude]
public PropertyValueAxisPie2D YAxis { get; }

Property Value

PropertyValueAxisPie2D

Methods

GetEvaluatedXAxisValue()

Gets the X-axis value for the current data point. This method must be overridden in derived classes to provide chart-specific X-axis evaluation logic.

public override ExpressionValue GetEvaluatedXAxisValue()

Returns

ExpressionValue

An ExpressionValue representing the X-axis coordinate for the current data point.

Exceptions

NotImplementedException

Thrown when called on the base class. Derived classes must override this method.

GetEvaluatedYAxisValue()

Gets the Y-axis value for the current data point. This method must be overridden in derived classes to provide chart-specific Y-axis evaluation logic.

public override ExpressionValue GetEvaluatedYAxisValue()

Returns

ExpressionValue

An ExpressionValue representing the Y-axis coordinate for the current data point.

Exceptions

NotImplementedException

Thrown when called on the base class. Derived classes must override this method.

GetSortingValue()

Gets the sorting value used to order data points during iteration.

public override string GetSortingValue()

Returns

string

A string representing the sorting criteria.

Exceptions

NotImplementedException

This method must be overridden in derived classes.

GetXAxisValueFormula()

Retrieves the formula string for the X axis value.

public override string GetXAxisValueFormula()

Returns

string

The formula string representing the X axis value expression.

GetYAxisValueFormula()

Retrieves the formula string for the Y axis value.

public override string GetYAxisValueFormula()

Returns

string

The formula string representing the Y axis value expression.

IsFeatureEnabled()

Donut charts are enabled by default.

public override bool IsFeatureEnabled()

Returns

bool

IsOtherChartSegment()

Determines whether the current data point should be aggregated into the "others" segment.

public override bool IsOtherChartSegment()

Returns

bool

true if the current data point index exceeds the maximum allowed segments; otherwise, false.

PrepareChartSegment()

Prepares a single chart segment based on the current data point.

public override void PrepareChartSegment()

Exceptions

NotImplementedException

This method must be overridden in derived classes.

PrepareOtherChartSegment()

Prepares the "others" chart segment for data points that exceed the maximum segment count.

public override void PrepareOtherChartSegment()

Exceptions

NotImplementedException

This method must be overridden in derived classes.

ResetDataPoints()

Resets all data points to their initial state.

public override void ResetDataPoints()

Exceptions

NotImplementedException

This method must be overridden in derived classes.

WantsRecord()

Determines whether the consumer wants to process the current data record.

public override bool WantsRecord()

Returns

bool

true if the consumer wants to process the current record; otherwise, false.