Table of Contents

Class ViewSmithBase

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

Smith chart view's base class.

[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class ViewSmithBase : ViewRoundBase, IChartNode, IDisposable
Inheritance
ViewSmithBase
Implements
Derived
Inherited Members

Properties

Annotations

Annotations list.

public AnnotationSmithList Annotations { get; set; }

Property Value

AnnotationSmithList

LegendBox

Legend box. Shows description of series

public LegendBoxSmith LegendBox { get; set; }

Property Value

LegendBoxSmith

Markers

Smith markers

public SmithEventMarkerList Markers { get; set; }

Property Value

SmithEventMarkerList

PointLineSeries

Smith point line series.

public PointLineSeriesSmithList PointLineSeries { get; set; }

Property Value

PointLineSeriesSmithList

ZoomPanOptions

Zoom, pan and auto-fit options

public ZoomPanOptionsSmith ZoomPanOptions { get; set; }

Property Value

ZoomPanOptionsSmith

Methods

CalcMarginEffects()

re-calculates the margin area and drawcenter, marks all affected to dirty.

protected override void CalcMarginEffects()

Construct()

Constructor calls base constructor

protected override void Construct()

CreateLegendBox()

Create new Legend Box form Smith Chart

protected override void CreateLegendBox()

CreateZoomPanOptions()

Create new Zoom Pan Options

protected override void CreateZoomPanOptions()

DeviceButtonClickCheck(ObjectType, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, bool)

Check if user interactive device button was clicked.

protected override bool DeviceButtonClickCheck(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, bool bIsOutsideGraphArea, bool front = true)

Parameters

type View2D.ObjectType
param type M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)
eventArguments UserInteractiveDeviceEventArgs
param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)
eventType UserInteractiveDeviceEventType
param eventType M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)
bIsOutsideGraphArea bool
param bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)
front bool
param front M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)

Returns

bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)

DeviceButtonDownCheck(ObjectType, UserInteractiveDeviceEventArgs, bool, bool)

Virtual method to override if the class wants to handle user interactive device button down event of axis on proper time.

protected override bool DeviceButtonDownCheck(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, bool bIsOutsideGraphArea, bool front = true)

Parameters

type View2D.ObjectType
param type M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)
eventArguments UserInteractiveDeviceEventArgs
param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)
bIsOutsideGraphArea bool
param bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)
front bool
param front M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)

Returns

bool

True if the event was consumed.

Remarks

This version does nothing.

DeviceButtonUpCheck(ObjectType, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, ref bool, ref bool, bool)

Checks if the user interactive device button up event applies to the given item.

protected override void DeviceButtonUpCheck(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, bool bIsOutsideGraphArea, ref bool bMousedObjectFirst, ref bool bExit, bool front = true)

Parameters

type View2D.ObjectType
param type M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)
eventArguments UserInteractiveDeviceEventArgs
param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)
eventType UserInteractiveDeviceEventType
param eventType M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)
bIsOutsideGraphArea bool
param bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)
bMousedObjectFirst bool
param bMousedObjectFirst M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)
bExit bool
param bExit M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)
front bool
param front M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)

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.

FreeZoomDrawData()

Free DD of the zoom system. Rects etc.

protected override void FreeZoomDrawData()

GetZoomPadding()

Getter of the ZoomPadding, supported by Round and 3D Views ZoomPanOptions.

Returns empty (default) value if ZoomPanOptions is not set.

protected override Padding GetZoomPadding()

Returns

Padding

ZoomPadding of the given view, if supported.

HandleDeviceMoved(ObjectType, UserInteractiveDeviceEventArgs, bool, UserInteractiveObject, bool)

Occurs when the mouse is moved

protected override bool HandleDeviceMoved(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, bool bIsOutsideGraphArea, UserInteractiveObject mibHandled, bool front = true)

Parameters

type View2D.ObjectType
param type M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)
eventArguments UserInteractiveDeviceEventArgs
param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)
bIsOutsideGraphArea bool
param bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)
mibHandled UserInteractiveObject
param mibHandled M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)
front bool
param front M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)

Returns

bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)

SetZoomPanOptions(ZoomPanOptionsSmith)

Set zoom pan options for smith

protected void SetZoomPanOptions(ZoomPanOptionsSmith value)

Parameters

value ZoomPanOptionsSmith
param value M:LightningChartLib.WinForms.Charting.Views.ViewSmith.ViewSmithBase.SetZoomPanOptions(LightningChartLib.WinForms.Charting.Views.ViewSmith.ZoomPanOptionsSmith)

ToString()

Convert class description to string.

public override string ToString()

Returns

string

Class description as a string.