Table of Contents

Class ChartOptions

Namespace
LightningChartLib.WinForms.Charting
Assembly
LightningChart.WinForms.Charting.NET4.dll

Generic options controlling LightningChart behavior.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class ChartOptions : ChartNode, IChartNode, IDisposable
Inheritance
ChartOptions
Implements
Inherited Members

Constructors

ChartOptions()

Chart Options

public ChartOptions()

ChartOptions(IChartNode)

Chart Options

public ChartOptions(IChartNode owner)

Parameters

owner IChartNode
param owner M:LightningChartLib.WinForms.Charting.ChartOptions.#ctor(LightningChartLib.WinForms.Charting.IChartNode)

Properties

AllowDPIChangeInduceWindowResize

Boolean to check if automatic LightningChart resizing / repositioning is allowed when application window DPI changes. Default value is false.

public bool AllowDPIChangeInduceWindowResize { get; set; }

Property Value

bool

AllowInternalCursorChange

Allow internal cursor change.

public bool AllowInternalCursorChange { get; set; }

Property Value

bool

AllowUserInteraction

Allow user interaction with interaction device (e.g. mouse). Interaction device hit testing with objects cause CPU overhead when the device is moved. If user device interaction is not absolute necessary directly within chart and if you want to maximize the performance, set this false.

public bool AllowUserInteraction { get; set; }

Property Value

bool

Remarks

Major part of device hit test overhead is caused by series testing. Series have AllowUserInteraction property too, so set at least that disabled while making real-time monitoring.

ChartMessageMinimumLevel

Allows setting a minimum ChartMessage MessageSeverity level. Messages with a MessageSeverity below the minimum level will not be sent to the user.

public MessageSeverity ChartMessageMinimumLevel { get; set; }

Property Value

MessageSeverity

RaiseEventsAfterDraw

Defines if the events raised during rendering should be emitted only at the end of the drawing (frame) or when the changes occur.

public bool RaiseEventsAfterDraw { get; set; }

Property Value

bool

Remarks

If false, events are raised whenever they occur. Some properties or data may not be valid, because the control draw may not have been finished. That is the case for example when using a series data cursor, and adjusting X or Y-axis scale.

If true, events are raised in sequence after the chart drawing has been finished. It ensures all data is valid for external data handling.

This only applies to chart's specific events, not events derived from ancestor CustomControl. Error event is not enqueued, but raised whenever it occurs.

ShowDebugData

Controls showing debugging information on chart. This is intended only for debugging and special situations.

public bool ShowDebugData { get; set; }

Property Value

bool

ShowHints

Selects when to show hints about the use of some critical properties.

public HintsVisible ShowHints { get; set; }

Property Value

HintsVisible

ThrowChartExceptions

When set to true, throws a ChartException on all ChartMessage events with a MessageSeverity level above Warning.

public bool ThrowChartExceptions { get; set; }

Property Value

bool

WheelRequiresFocus

Defines if the chart reacts to wheel events without focus. This is useful especially on situations when chart is in scrollable control and it's not wished that the chart processes the wheel events.

public bool WheelRequiresFocus { get; set; }

Property Value

bool

Methods

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true if managed resources should be disposed, otherwise false.

ToString()

Convert class description to string

public override string ToString()

Returns

string

String