Table of Contents

Class PropertyChartEngineBase

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

Partial class implementing combit.Reporting.DataCollection.IDataCollectionConsumer2D for chart data consumption. Handles data point collection, caching, and aggregation for chart rendering.

[JsonDerivedType(typeof(PropertyChartEngineAreaSimple), "areaSimple")]
[JsonDerivedType(typeof(PropertyChartEngineAreaStacked), "areaStacked")]
[JsonDerivedType(typeof(PropertyChartEngineAreaStackedRelative), "areaStackedRelative")]
[JsonDerivedType(typeof(PropertyChartEngineBar2D), "bar2D")]
[JsonDerivedType(typeof(PropertyChartEngineBar2DClustered), "bar2DClustered")]
[JsonDerivedType(typeof(PropertyChartEngineBar2DStacked), "bar2DStacked")]
[JsonDerivedType(typeof(PropertyChartEngineBar2DStackedRelative), "bar2DStackedRelative")]
[JsonDerivedType(typeof(PropertyChartEngineBar3D), "bar3D")]
[JsonDerivedType(typeof(PropertyChartEngineBar3DClustered), "bar3DClustered")]
[JsonDerivedType(typeof(PropertyChartEngineBar3DMultiRow), "bar3DMultiRow")]
[JsonDerivedType(typeof(PropertyChartEngineBar3DStacked), "bar3DStacked")]
[JsonDerivedType(typeof(PropertyChartEngineBar3DStackedRelative), "bar3DStackedRelative")]
[JsonDerivedType(typeof(PropertyChartEngineBubbleScattered), "bubbleScattered")]
[JsonDerivedType(typeof(PropertyChartEngineBubbleSorted), "bubbleSorted")]
[JsonDerivedType(typeof(PropertyChartEngineDonut2D), "donut2D")]
[JsonDerivedType(typeof(PropertyChartEngineDonut3D), "donut3D")]
[JsonDerivedType(typeof(PropertyChartEngineFunnelHorizontal), "funnelHorizontal")]
[JsonDerivedType(typeof(PropertyChartEngineFunnelVertical), "funnelVertical")]
[JsonDerivedType(typeof(PropertyChartEngineLineMultiRow), "lineMultiRow")]
[JsonDerivedType(typeof(PropertyChartEngineLineSimple), "lineSimple")]
[JsonDerivedType(typeof(PropertyChartEngineLineStacked), "lineStacked")]
[JsonDerivedType(typeof(PropertyChartEngineLineStackedRelative), "lineStackedRelative")]
[JsonDerivedType(typeof(PropertyChartEnginePie2D), "pie2D")]
[JsonDerivedType(typeof(PropertyChartEnginePie3D), "pie3D")]
[JsonDerivedType(typeof(PropertyChartEngineRadar), "radar")]
[JsonDerivedType(typeof(PropertyChartEngineRadarClustered), "radarClustered")]
[JsonDerivedType(typeof(PropertyChartEngineRadarSimple), "radarSimple")]
[JsonDerivedType(typeof(PropertyChartEngineRadarStacked), "radarStacked")]
[JsonDerivedType(typeof(PropertyChartEngineRadarStackedRelative), "radarStackedRelative")]
[JsonDerivedType(typeof(PropertyChartEngineRscript), "rscript")]
[JsonDerivedType(typeof(PropertyChartEngineShapeFile), "shapeFile")]
[JsonDerivedType(typeof(PropertyChartEngineTreeMapClustered), "treeMapClustered")]
[JsonDerivedType(typeof(PropertyChartEngineTreeMapSingle), "treeMapSingle")]
public class PropertyChartEngineBase : DomItem
Inheritance
PropertyChartEngineBase
Derived
Inherited Members

Properties

FrameColor

Gets or sets frame line color expression.

public string FrameColor { get; set; }

Property Value

string

UseLightEffect

Gets or sets whether lighting effects are used.

public string UseLightEffect { get; set; }

Property Value

string

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 virtual 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 virtual 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 virtual 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 virtual string GetXAxisValueFormula()

Returns

string

The formula string representing the X axis value expression.

GetYAxisValueFormula()

Retrieves the formula string for the Y axis value.

public virtual string GetYAxisValueFormula()

Returns

string

The formula string representing the Y axis value expression.

IsOtherChartSegment()

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

public virtual bool IsOtherChartSegment()

Returns

bool

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

IterateDataCache()

Iterates through the cached data points, preparing chart segments and handling "others" aggregation. Sets up the chart identifier provider, restores snapshots for field evaluation, and processes each data point.

public void IterateDataCache()

PrepareChartSegment()

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

public virtual 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 virtual void PrepareOtherChartSegment()

Exceptions

NotImplementedException

This method must be overridden in derived classes.

ResetDataPoints()

Resets all data points to their initial state.

public virtual 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 virtual bool WantsRecord()

Returns

bool

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