Skip to main content

Class ChartEngine

Namespace: VelloSharp.ChartEngine
Assembly: VelloSharp.ChartEngine.dll

High-level wrapper over the native chart engine exposed via FFI.

public sealed class ChartEngine : IDisposable

Inheritance​

object ← ChartEngine

Implements​

IDisposable

Inherited Members​

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors​

ChartEngine(ChartEngineOptions)​

public ChartEngine(ChartEngineOptions options)

Parameters​

options ChartEngineOptions

Properties​

Diagnostics​

public FrameDiagnosticsCollector Diagnostics { get; }

Property Value​

FrameDiagnosticsCollector

LastFrameStats​

public FrameStats LastFrameStats { get; }

Property Value​

FrameStats

Options​

public ChartEngineOptions Options { get; }

Property Value​

ChartEngineOptions

Methods​

AnimateAnnotation(string, bool, TimeSpan?)​

public void AnimateAnnotation(string annotationId, bool highlighted, TimeSpan? duration = null)

Parameters​

annotationId string

highlighted bool

duration TimeSpan?

AnimateCursor(ChartCursorUpdate)​

public void AnimateCursor(ChartCursorUpdate update)

Parameters​

update ChartCursorUpdate

AnimateSeriesStrokeWidth(uint, double, TimeSpan)​

public void AnimateSeriesStrokeWidth(uint seriesId, double targetStrokeWidth, TimeSpan duration)

Parameters​

seriesId uint

targetStrokeWidth double

duration TimeSpan

AnimateStreaming(ReadOnlySpan<ChartStreamingUpdate>)​

public void AnimateStreaming(ReadOnlySpan<ChartStreamingUpdate> updates)

Parameters​

updates ReadOnlySpan<ChartStreamingUpdate>

ApplySeriesOverrides(ReadOnlySpan<ChartSeriesOverride>)​

public void ApplySeriesOverrides(ReadOnlySpan<ChartSeriesOverride> overrides)

Parameters​

overrides ReadOnlySpan<ChartSeriesOverride>

ConfigureComposition(ChartComposition?)​

public void ConfigureComposition(ChartComposition? composition)

Parameters​

composition ChartComposition?

ConfigureSeries(ReadOnlySpan<ChartSeriesDefinition>)​

public void ConfigureSeries(ReadOnlySpan<ChartSeriesDefinition> definitions)

Parameters​

definitions ReadOnlySpan<ChartSeriesDefinition>

ConfigureTickSource(IFrameTickSource?, bool)​

public void ConfigureTickSource(IFrameTickSource? tickSource, bool ownsTickSource = false)

Parameters​

tickSource IFrameTickSource?

ownsTickSource bool

Dispose()​

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetFrameMetadata()​

public ChartFrameMetadata GetFrameMetadata()

Returns​

ChartFrameMetadata

PumpData(ReadOnlySpan<ChartSamplePoint>)​

public void PumpData(ReadOnlySpan<ChartSamplePoint> samples)

Parameters​

samples ReadOnlySpan<ChartSamplePoint>

RecordMetric(ChartMetric)​

public void RecordMetric(ChartMetric metric)

Parameters​

metric ChartMetric

Render(Scene, uint, uint)​

public void Render(Scene scene, uint width, uint height)

Parameters​

scene Scene

width uint

height uint

ResetSeriesStrokeWidth(uint, TimeSpan)​

public void ResetSeriesStrokeWidth(uint seriesId, TimeSpan duration)

Parameters​

seriesId uint

duration TimeSpan

ScheduleRender(FrameTickCallback)​

public void ScheduleRender(FrameTickCallback callback)

Parameters​

callback FrameTickCallback

SetAutomaticScheduling(bool)​

public void SetAutomaticScheduling(bool enabled)

Parameters​

enabled bool

SetTelemetrySink(IChartTelemetrySink?)​

public void SetTelemetrySink(IChartTelemetrySink? telemetrySink)

Parameters​

telemetrySink IChartTelemetrySink?

TryAdvanceFrame(TimeSpan?)​

public bool TryAdvanceFrame(TimeSpan? timestampOverride = null)

Parameters​

timestampOverride TimeSpan?

Returns​

bool

UpdatePalette(ReadOnlySpan<ChartColor>)​

public void UpdatePalette(ReadOnlySpan<ChartColor> palette)

Parameters​

palette ReadOnlySpan<ChartColor>