Class ViewPolarBase
- Namespace
- LightningChartLib.WinForms.Charting.Views.ViewPolar
- Assembly
- LightningChart.WinForms.Charting.NET4.dll
Polar chart view's base class.
[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class ViewPolarBase : ViewRoundBase, IChartNode, IDisposable
- Inheritance
-
ViewPolarBase
- Implements
- Derived
- Inherited Members
Properties
Annotations
Annotations list.
public AnnotationPolarList Annotations { get; set; }
Property Value
AreaSeries
Polar area series list.
public AreaSeriesPolarList AreaSeries { get; set; }
Property Value
IntensityGridSeries
Polar intensity series list.
public IntensityGridSeriesPolarList IntensityGridSeries { get; set; }
Property Value
LegendBox
Legend box. Shows description of series.
public LegendBoxPolar LegendBox { get; set; }
Property Value
Markers
Polar markers.
public PolarEventMarkerList Markers { get; set; }
Property Value
PointLineSeries
Polar point line series list.
public PointLineSeriesPolarList PointLineSeries { get; set; }
Property Value
Sectors
Sector list.
public SectorList Sectors { get; set; }
Property Value
ZoomPanOptions
Zoom, pan and auto-fit options.
public ZoomPanOptionsPolar ZoomPanOptions { get; set; }
Property Value
Methods
CalcMarginEffects()
re-calculates the margin area and drawcenter, marks all affected to dirty.
protected override void CalcMarginEffects()
Construct()
Call base constructor
protected override void Construct()
CreateLegendBox()
Creates the legend box.
protected override void CreateLegendBox()
CreateZoomPanOptions()
Create new Zoom Pan Options for Polar
protected override void CreateZoomPanOptions()
DeviceButtonClickCheck(ObjectType, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, bool)
Check if mouse 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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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 down event of axis on proper time.
protected override bool DeviceButtonDownCheck(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, bool bIsOutsideGraphArea, bool front = true)
Parameters
typeView2D.ObjectTypeType of an object
eventArgumentsUserInteractiveDeviceEventArgsEvent
bIsOutsideGraphAreaboolCheck if device is outside or inside the Graph area
frontboolparam front M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.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 up event applies to the given item.
protected override void DeviceButtonUpCheck(View2D.ObjectType type, UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, bool bIsOutsideGraphArea, ref bool interactedObjectFirst, ref bool bExit, bool front = true)
Parameters
typeView2D.ObjectTypeparam type M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean) interactedObjectFirstboolparam interactedObjectFirst M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.
FreeZoomDrawData()
Free DD of the zoom system. Rects etc.
protected override void FreeZoomDrawData()
GetDataBounds()
Get Data Bounds in PX.
protected override RectangleXYF GetDataBounds()
Returns
- RectangleXYF
rect defining the rectangle that fully encompasses all of the visible (non clipped) datapoints. Rect is defined in actual pixels.
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.
HandleDeviceButtonUpAction(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, ref bool, ref bool, UserInteractiveObject)
Handle user interactive device up event.
protected override void HandleDeviceButtonUpAction(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, bool bIsOutsideGraphArea, ref bool bMousedObjectFirst, ref bool bExit, UserInteractiveObject item)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject) bIsOutsideGraphAreaboolparam bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject) bMousedObjectFirstboolparam bMousedObjectFirst M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject) bExitboolparam bExit M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject) itemUserInteractiveObjectparam item M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject)
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
typeView2D.ObjectTypeparam type M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.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.ViewPolarBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)
SetZoomPanOptions(ZoomPanOptionsPolar)
Set zoom pan options for Polar
protected void SetZoomPanOptions(ZoomPanOptionsPolar value)
Parameters
valueZoomPanOptionsPolarparam value M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.SetZoomPanOptions(LightningChartLib.WinForms.Charting.Views.ViewPolar.ZoomPanOptionsPolar)
ToString()
Convert class description to string
public override string ToString()
Returns
- string
String
WheelPanOnAxis(bool, AxisPolar)
Pan of user interactive device wheel on Axis.
protected void WheelPanOnAxis(bool zoomIn, AxisPolar axis)
Parameters
zoomInboolparam zoomIn M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.WheelPanOnAxis(System.Boolean,LightningChartLib.WinForms.Charting.Axes.AxisPolar) axisAxisPolarparam axis M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.WheelPanOnAxis(System.Boolean,LightningChartLib.WinForms.Charting.Axes.AxisPolar)
WheelZoomOnAxis(bool, AxisPolar, int, int)
Zoom on Axis using user interactive device wheel.
protected void WheelZoomOnAxis(bool zoomIn, AxisPolar axis, int iCoordX, int iCoordY)
Parameters
zoomInboolparam zoomIn M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,LightningChartLib.WinForms.Charting.Axes.AxisPolar,System.Int32,System.Int32) axisAxisPolarparam axis M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,LightningChartLib.WinForms.Charting.Axes.AxisPolar,System.Int32,System.Int32) iCoordXintparam iCoordX M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,LightningChartLib.WinForms.Charting.Axes.AxisPolar,System.Int32,System.Int32) iCoordYintparam iCoordY M:LightningChartLib.WinForms.Charting.Views.ViewPolar.ViewPolarBase.WheelZoomOnAxis(System.Boolean,LightningChartLib.WinForms.Charting.Axes.AxisPolar,System.Int32,System.Int32)