Class ViewRoundBase

Namespace

LightningChartLib.WinForms.Charting.Views.ViewRound

Assembly

LightningChart.WinForms.Charting.NET4.dll

Base class for all round views. These are Smith -and Polar views.

[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class ViewRoundBase : View2D, IChartNode, IDisposable

Inheritance

object

ChartNode

ViewBase

View2D

ViewRoundBase

Implements

IChartNode

IDisposable

Derived

ViewPolarBase

ViewSmithBase

Inherited Members

View2D.SetGraphBackground(Fill)

View2D.GetMarginsRect(bool)

View2D.CreateZoomPanOptions()

View2D.GraphBackground

ViewBase.GetZoomPadding()

ViewBase.HandleMarginsChanged()

ViewBase.MoveOnSameCoordinate(int, int)

ViewBase.HandleDeviceMoveOnLegendBoxScrollBars(LegendBoxBase, UserInteractiveDeviceEventArgs, bool)

ViewBase.HandleHorizontalScrollBarsDeviceMove(UserInteractiveDeviceEventArgs, bool, UserInteractiveObject)

ViewBase.HandleVerticalScrollBarsDeviceMove(UserInteractiveDeviceEventArgs, bool, UserInteractiveObject)

ViewBase.HandleHorizontalScrollBarsDeviceButtonUp(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, ref bool, ref bool)

ViewBase.HandleDeviceButtonUpOnLegendBoxScrollBars(LegendBoxBase, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, ref bool, ref bool)

ViewBase.HandleVerticalScrollBarsDeviceButtonUp(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool, ref bool, ref bool)

ViewBase.HandleHorizontalScrollBarsDeviceButtonClicked(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool)

ViewBase.HandleDeviceButtonClickedOnLegendBoxScrollBars(LegendBoxBase, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool)

ViewBase.HandleVerticalScrollBarsDeviceButtonClicked(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool)

ViewBase.DeviceButtonDoubleClicked(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)

ViewBase.HandleDeviceMoveAction(UserInteractiveDeviceEventArgs, bool, UserInteractiveObject)

ViewBase.HandleDeviceButtonDownAction(UserInteractiveDeviceEventArgs, bool, UserInteractiveObject)

ViewBase.HandleDeviceButtonDownOnLegendBoxScrollBars(LegendBoxBase, UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool)

ViewBase.HandleHorizontalScrollBarsDeviceButtonDown(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool)

ViewBase.HandleVerticalScrollBarsDeviceButtonDown(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, bool)

ViewBase.SetInteractiveObjectToIdle(UserInteractiveObject)

ViewBase.ItemListChanged(object, ListChangedEventArgs)

ViewBase.OwnerChart

ViewBase.Margins

ViewBase.CustomMessage

ViewBase.MarginsChanged

ChartNode.Dispose()

ChartNode.CheckIfInvalidRefAndComplain(object[])

ChartNode.CheckIfInvalidRefAndComplain(object)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AutoSizeMargins

Automatically size margins based on LegendBox position and size.

public bool AutoSizeMargins { get; set; }

Property Value

bool

Border

Border Options for View.

public ThinBorder Border { get; set; }

Property Value

ThinBorder

ZoomScale

Current zooming scale. 1 is the default zoom that shows the circle at it's maximum size so that it just fills the view area reduced by the margins.

public double ZoomScale { get; set; }

Property Value

double

Methods

CalcMarginEffects()

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

protected override void CalcMarginEffects()

CalcRadius(double)

Calculates radius in pixels for given zoom factor.

protected abstract double CalcRadius(double zoomFactor)

Parameters

zoomFactor double

LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.m_dZoomScale

Returns

double

Radius in pixels.

CalcRadius(double, AxisRoundBase)

Calculates radius in pixels for given zoom factor.

protected double CalcRadius(double zoomFactor, AxisRoundBase axis)

Parameters

zoomFactor double

ViewRound.ViewRoundBase.m_fZoomScale

axis AxisRoundBase

AxisRoundBase

Returns

double

Radius in pixels.

Construct()

Virtual construction / initialization method. Called by all constructors.

protected virtual void Construct()

CoordsToUCValue(PointFloat, bool)

Convert absolute screen coordinates to relative unit circle coordinates.

public PointUnitCircle CoordsToUCValue(PointFloat screenCoords, bool useDip = true)

Parameters

screenCoords PointFloat

Coords in screen space.

useDip bool

Use DIPs instead of pixels as parameters.

Returns

PointUnitCircle

Given coordinates in relative unit circle space, with origo at the center of the circle.

CoordsToUCValue(ref PointFloat, bool)

Convert absolute screen coordinates to relative unit circle coordinates. The given pointfloat is modified.

public void CoordsToUCValue(ref PointFloat screenCoords, bool useDip = true)

Parameters

screenCoords PointFloat

Coordinates in screen space on entry. On exit contains matching unit circle coordinates.

useDip bool

Use DIPs instead of pixels as parameters.

CreateLegendBox()

Required method that creates proper legend box and sets the m_LegendBox property

protected abstract void CreateLegendBox()

CreatetbMarginBorder()

Create Border

protected virtual void CreatetbMarginBorder()

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

User interactive device click handler for given object types.

protected virtual 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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.DeviceButtonClickCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean)

Remarks

This implementation is intentionally empty.

DeviceButtonClicked(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)

User interactive device button has been clicked.

protected override bool DeviceButtonClicked(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)

Parameters

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

chart LightningChart

param chart M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

Returns

bool

returns M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

Remarks

Note that we come here on button up. Clicked event comes first, then up.

DeviceButtonDown(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)

Mouse button has been clicked down.

protected override bool DeviceButtonDown(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)

Parameters

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

chart LightningChart

param chart M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

Returns

bool

returns M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

DeviceButtonDownCheck(ObjectType, UserInteractiveDeviceEventArgs, bool, bool)

Virtual method to override if the class wants to handle mouse down event of axis on proper time.

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

Parameters

type View2D.ObjectType

param type M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)

bIsOutsideGraphArea bool

param bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonDownCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,System.Boolean)

front bool

Determines if the object is considered being in front or in back. Actual meaning differs between ObjectTypes

Returns

bool

True if the event was consumed.

Remarks

This version does nothing.

DeviceButtonUp(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)

Mouse button has been released.

protected override bool DeviceButtonUp(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)

Parameters

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

chart LightningChart

param chart M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

Returns

bool

returns M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

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

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

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

Parameters

type View2D.ObjectType

param type M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.DeviceButtonUpCheck(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,System.Boolean)

interactedObjectFirst bool

param interactedObjectFirst M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.

FireAfterZoomingEvent(float)

Event launcher for zoom scale changes. Called after the zooming. Suits like this for polar, override for smith

protected virtual bool FireAfterZoomingEvent(float OldScale)

Parameters

OldScale float

Old zoom scale

Returns

bool

True if rendering frame should be stopped.

FireBeforePanningEvent(PointUnitCircle)

Event launcher for zoom center changes. Suits like this for polar, override for smith

protected virtual bool FireBeforePanningEvent(PointUnitCircle newCenter)

Parameters

newCenter PointUnitCircle

New zoom center as UC

Returns

bool

True if zoom was successful. False if canceled.

FireBeforeZoomingEvent(float)

Event launcher for zoom scale changes. Called before the zooming. Suits like this for polar, override for smith

protected virtual bool FireBeforeZoomingEvent(float NewScale)

Parameters

NewScale float

New zoom scale

Returns

bool

True if value change is ok, false if zoom should not happen.

FirePannedEvent(PointUnitCircle)

Event launcher for zoom center changes. Called after the pan. Suits like this for polar, override for smith

protected virtual bool FirePannedEvent(PointUnitCircle oldCenter)

Parameters

oldCenter PointUnitCircle

Old center as UC

Returns

bool

True if rendering should be canceled.

FixAspectRatio(ref RectangleXYF, bool)

Fixes aspect ratio to match the view aspect ratio. Keeps X,Y coords if Center property is false (default), negative sizes allowed (suggested in some cases). Does not reduce the rect size, only increases it.

protected void FixAspectRatio(ref RectangleXYF rect, bool center = false)

Parameters

rect RectangleXYF

Increases the size same amount on both directions.

center bool

If true, keep the rect center in place. Otherwise the X/Y is kept in place (which is not necessarily the left/top)

Remarks

Center property can be used to increase the size on both directions.

FreeMarkersDrawData(bool)

Free marker draw data.

public virtual void FreeMarkersDrawData(bool creatingDeviceOrDisposing = false)

Parameters

creatingDeviceOrDisposing bool

param creatingDeviceOrDisposing M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.FreeMarkersDrawData(System.Boolean)

FreeZoomDrawData()

Free DD of the zoom system. Rects etc.

protected override void FreeZoomDrawData()

GetChartDiameterAndCenter(out int, out int, out int)

Get Smith or Polar charts outer diameter and center point in screen coordinates.

public bool GetChartDiameterAndCenter(out int diameter, out int centerX, out int centerY)

Parameters

diameter int

Diameter (2 * radius).

centerX int

Center point X.

centerY int

Center point Y.

Returns

bool

True if successfully resolved.

Remarks

Note that each axis is smaller than the outer diameter. returned here.

GetDataBounds()

Getter of the bounds of the data in screen pixels (zoomed) for determination of the correct scale and center offset for the zooming so that all data is fit to view.

protected abstract RectangleXYF GetDataBounds()

Returns

RectangleXYF

Bounding box of the data in screen coordinates.

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

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject)

bIsOutsideGraphArea bool

param bIsOutsideGraphArea M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject)

bMousedObjectFirst bool

param bMousedObjectFirst M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject)

bExit bool

param bExit M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.HandleDeviceButtonUpAction(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,System.Boolean,System.Boolean@,System.Boolean@,LightningChartLib.WinForms.Charting.UserInteractiveObject)

item UserInteractiveObject

param item M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.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)

Handles user interactive device move events of the given type.

protected virtual 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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.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.ViewRound.ViewRoundBase.HandleDeviceMoved(LightningChartLib.WinForms.Charting.Views.View2D.ObjectType,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,System.Boolean,LightningChartLib.WinForms.Charting.UserInteractiveObject,System.Boolean)

Remarks

This implementation intentionally empty.

HandleViewChanged()

Virtual method that is called when zoom or panning properties have changed or engine changed or margins changed or ... The Chart update cycle has not been ended yet.

protected virtual void HandleViewChanged()

Remarks

Remember to call the base classes method. It might be prudent to mark somewhere we're dirty, or just refresh the chart.

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

PositionOverGraph(CoordXY)

Check if position is over circular graph area. Meaning if it's inside the radius of the chart.

protected override bool PositionOverGraph(CoordXY coord)

Parameters

coord CoordXY

Position

Returns

bool

returns M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.PositionOverGraph(LightningChartLib.WinForms.Charting.CoordXY)

SetLegendBox(LegendBoxRound)

Set LegendBox

protected void SetLegendBox(LegendBoxRound value)

Parameters

value LegendBoxRound

param value M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.SetLegendBox(LightningChartLib.WinForms.Charting.Views.ViewRound.LegendBoxRound)

SetZoomCenter(PointUnitCircle, bool)

Setter of the Zoom center in UC coords. Emits corresponding zoom events if allowed.

protected virtual bool SetZoomCenter(PointUnitCircle newCenter, bool emitEvents = true)

Parameters

newCenter PointUnitCircle

New center of the view in UC coords.

emitEvents bool

If true, emits events that the user can use to cancel rendering or prevent the zoom operation.

Returns

bool

True if zoom center changed

ToString()

Convert class description to string

public override string ToString()

Returns

string

String

UCValueToCoord(PointFloat, bool)

Convert relative unit circle coordinates to absolute screen coordinates.

public PointFloat UCValueToCoord(PointFloat ucValue, bool useDip = true)

Parameters

ucValue PointFloat

Unit circle coordinates to convert.

useDip bool

Use DIPs instead of pixels as parameters.

Returns

PointFloat

Absolute screen coordinates matching the given parameter.

UCValueToCoord(ref PointFloat, bool)

Convert relative unit circle coordinates to absolute screen coordinates. The given pointfloat is modified.

public void UCValueToCoord(ref PointFloat coords, bool useDip = true)

Parameters

coords PointFloat

Screen coordinates to convert into unit circle coordinates.

useDip bool

Use DIPs instead of pixels as parameters.

UCValueToCoord(PointUnitCircle, bool)

Convert relative unit circle coordinates to absolute screen coordinates.

public PointFloat UCValueToCoord(PointUnitCircle ucValue, bool useDip = true)

Parameters

ucValue PointUnitCircle

Unit circle coordinates to convert.

useDip bool

Use DIPs instead of pixels as parameters.

Returns

PointFloat

Absolute screen coordinates matching the given parameter.

UserDeviceCheckStarting()

To be called as beginning of mouse move and mouse click checks / handling to cleanup states.

protected virtual void UserDeviceCheckStarting()

UserInteractiveDeviceMoved(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)

User interactive device has been moved.

protected override bool UserInteractiveDeviceMoved(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)

Parameters

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

eventType UserInteractiveDeviceEventType

param eventType M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

chart LightningChart

param chart M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

Returns

bool

returns M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)

WheelScrolled(UserInteractiveDeviceEventArgs, LightningChart)

Mouse wheel has been scrolled.

public override bool WheelScrolled(UserInteractiveDeviceEventArgs eventArguments, LightningChart chart)

Parameters

eventArguments UserInteractiveDeviceEventArgs

param eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)

chart LightningChart

param chart M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)

Returns

bool

returns M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)

Zoom(int, int, int, int)

Zoom the chart in or out. If stop point X is greater than start point X, zooms in. If stop point X is less than start point X action follows RightToLeftZoom property.

public void Zoom(int startX, int startY, int stopX, int stopY)

Parameters

startX int

Zoom start point X.

startY int

Zoom start point Y.

stopX int

Zoom stop point X.

stopY int

Zoom stop point Y.

ZoomByFactor(PointInt, float, bool)

Zoom by given factor and around given view center as DIP or screen coordinates.

public void ZoomByFactor(PointInt zoomCenterCoord, float zoomFactor, bool UseDIP = true)

Parameters

zoomCenterCoord PointInt

Screen coordinates of the new center point [default input in DIPs]

zoomFactor float

Factor to modify the zoom scale by.

UseDIP bool

Defines if the input value is in DIP or PX

ZoomCenterChanged()

Reacts to changes in ZoomCenter property, updates drawing center quietly from zoom center.

protected virtual void ZoomCenterChanged()

ZoomToFit(ZoomAreaRound)

Zooms the view so that the data is visible at maximum possible size.

Area is either the full drawing area inside Margins or are further limited by ZoomPadding, depending on case. For more information, see options at ZoomAreaRound.

public void ZoomToFit(ZoomAreaRound zoomArea = ZoomAreaRound.Data)

Parameters

zoomArea ZoomAreaRound

param zoomArea M:LightningChartLib.WinForms.Charting.Views.ViewRound.ViewRoundBase.ZoomToFit(LightningChartLib.WinForms.Charting.ZoomAreaRound)

ZoomToLabelsArea()

Zooms the round view so that labels area is fitted to area inside
ZoomPadding.

Publicly accessible via ZoomToFit(ZoomAreaRound) method and ZoomToData.

public void ZoomToLabelsArea()

Events

BeforePanning

Panning is about to start.

public event ViewRoundBase.BeforePanningEventHandler BeforePanning

Event Type

ViewRoundBase.BeforePanningEventHandler

BeforeZooming

Zooming is about to start.

public event ViewRoundBase.BeforeZoomingEventHandler BeforeZooming

Event Type

ViewRoundBase.BeforeZoomingEventHandler

Panned

Panning has ended.

public event ViewRoundBase.PannedEventHandler Panned

Event Type

ViewRoundBase.PannedEventHandler

Zoomed

Zooming has ended.

public event ViewRoundBase.ZoomedEventHandler Zoomed

Event Type

ViewRoundBase.ZoomedEventHandler