Class ViewPolar
- Namespace
- LightningChartLib.WinForms.Charting.Views.ViewPolar
- Assembly
- LightningChart.WinForms.Charting.NET4.dll
ViewPolar class inherits ViewPolarBase.
[TypeConverter(typeof(ExpandableObjectConverter))]
public class ViewPolar : ViewPolarBase, IChartNode, IDisposable
- Inheritance
-
ViewPolar
- Implements
- Inherited Members
Constructors
ViewPolar()
Constructs new ViewPolar.
public ViewPolar()
ViewPolar(LightningChart)
Constructs new ViewPolar.
public ViewPolar(LightningChart owner)
Parameters
ownerLightningChartParent.
Properties
Axes
Polar axis list.
public AxisPolarList Axes { get; set; }
Property Value
AxisAutoPlacement
Placement of Amplitude Axis is done automatically. If false, it will consider start angle as 0.
public bool AxisAutoPlacement { get; set; }
Property Value
DataCursor
Data cursor shows series data value at or near mouse position.
public DataCursorPolar DataCursor { get; set; }
Property Value
ZoomCenter
Visible views center as unit circle coordinates.
public PointUnitCircle ZoomCenter { get; set; }
Property Value
Methods
CalcRadius(double)
Calculates radius in pixels for given zoom factor.
protected override double CalcRadius(double zoomFactor)
Parameters
zoomFactordoubleLightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.m_dZoomScale
Returns
- double
Radius in pixels.
Construct()
Common construct method, called from the base class.
protected override void Construct()
CreateDefaultPolarAxes()
Create Polar Axes.
public static List<AxisPolar> CreateDefaultPolarAxes()
Returns
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
TypeView2D.ObjectTypeparam Type M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) bIsOutsideGraphAreaboolparam bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean) Frontboolparam Front M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.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.ViewPolar.ViewPolar.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)
DeviceButtonDownCheck(ObjectType, UserInteractiveDeviceEventArgs, bool, bool)
Check if user interactive device button is down.
protected override bool DeviceButtonDownCheck(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, bool bIsOutsideGraphArea, bool front = true)
Parameters
typeView2D.ObjectTypeparam type M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) bIsOutsideGraphAreaboolparam bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean) frontboolparam front M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)
DeviceButtonUpCheck(ObjectType, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, ref bool, ref bool, bool)
Check if user interactive device button is up.
protected override void DeviceButtonUpCheck(View2D.ObjectType Type, UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, bool bIsOutsideGraphArea, ref bool bMousedObjectFirst, ref bool bExit, bool Front = true)
Parameters
TypeView2D.ObjectTypeparam Type M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) bIsOutsideGraphAreaboolparam bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) bMousedObjectFirstboolparam bMousedObjectFirst M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) bExitboolparam bExit M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) Frontboolparam Front M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.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
disposingbooltrue if managed resources should be disposed, otherwise false.
FreeMarkersDrawData(bool)
Free markers.
public override void FreeMarkersDrawData(bool creatingDeviceOrDisposing = false)
Parameters
creatingDeviceOrDisposingboolparam creatingDeviceOrDisposing M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.FreeMarkersDrawData(System.Boolean)
GetViewCornerValues(int, out PointPolar, out PointPolar)
Gets the current view's top-left and bottom-right corner axis values for the given axis.
public void GetViewCornerValues(int AxisIndex, out PointPolar leftTopCorner, out PointPolar rightBottomCorner)
Parameters
AxisIndexintAxis index to get the view values of.
leftTopCornerPointPolarViews top-left corner axis values.
rightBottomCornerPointPolarViews bottom-right corner axis values.
GetViewCornerValues(int, out PointPolar, out PointPolar, out PointPolar, out PointPolar)
Gets the current view's top-left, bottom-left, top-right and bottom-right corner axis values for the given axis.
public void GetViewCornerValues(int AxisIndex, out PointPolar leftTopCorner, out PointPolar rightTopCorner, out PointPolar rightBottomCorner, out PointPolar leftBottomCorner)
Parameters
AxisIndexintIndex of the axis to get the corner values in relation to.
leftTopCornerPointPolarViews top-left corner axis values.
rightTopCornerPointPolarViews top-right corner axis values.
rightBottomCornerPointPolarViews bottom-right corner axis values.
leftBottomCornerPointPolarViews bottom-left corner axis values.
HandleDeviceMoved(ObjectType, UserInteractiveDeviceEventArgs, bool, UserInteractiveObject, bool)
Occurs when user interactive device is moved.
protected override bool HandleDeviceMoved(View2D.ObjectType Type, UserInteractiveDeviceEventArgs eventArguments, bool bIsOutsideGraphArea, UserInteractiveObject mibHandled, bool Front = true)
Parameters
TypeView2D.ObjectTypeparam Type M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean) eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean) bIsOutsideGraphAreaboolparam bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean) mibHandledUserInteractiveObjectparam mibHandled M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean) Frontboolparam Front M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.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.ViewPolar.ViewPolar.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)
HandleMarginsChanged()
Handler gets Graph segment information
protected override void HandleMarginsChanged()
HandleViewChanged()
Virtual method that is called when zoom or panning properties have changed. The Chart update cycle has not been ended yet. Implement to react to the event.
protected override void HandleViewChanged()
OnDeserialized(StreamingContext)
OnDeserialized is called just after the object has been deserialized
[OnDeserialized]
protected void OnDeserialized(StreamingContext context)
Parameters
contextStreamingContextContext
UserDeviceCheckStarting()
To be called as beginingn of user interactive device move and click checks / handling to cleanup states.
protected override void UserDeviceCheckStarting()
WheelScrolled(UserInteractiveDeviceEventArgs, LightningChart)
Mouse wheel has been scrolled.
public override bool WheelScrolled(UserInteractiveDeviceEventArgs eventArguments, LightningChart chart)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart) chartLightningChartparam chart M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolar.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)
Zoom(PointPolar, PointPolar, int)
Zooms the view to given rectangle, defined by the axis values of the diagonal corners of the rectangle. If the rectangle is of wrong aspect ratio, center point of the given rectangle is followed.
public void Zoom(PointPolar Corner1, PointPolar Corner2, int AxisIndex = 0)
Parameters
Corner1PointPolarOne corner axis values.
Corner2PointPolarOne corner axis values.
AxisIndexintIndex of the axis to set the corner values in relation to.