Class ViewXY
- Namespace
- LightningChartLib.WinForms.Charting.Views.ViewXY
- Assembly
- LightningChart.WinForms.Charting.NET4.dll
XY graph view. Allows super-fast drawing of lines and bars.
[TypeConverter(typeof(ExpandableObjectConverter))]
public class ViewXY : View2D, IChartNode, IDisposable
- Inheritance
-
ViewXY
- Implements
- Inherited Members
Constructors
ViewXY()
Constructor.
public ViewXY()
ViewXY(LightningChart)
Constructor.
public ViewXY(LightningChart owner)
Parameters
ownerLightningChartparam owner M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.#ctor(LightningChartLib.WinForms.Charting.LightningChart)
Properties
Annotations
Annotations
public AnnotationXYList Annotations { get; set; }
Property Value
ApplyZIndex
Gets or sets the Rendering order index.
public bool ApplyZIndex { get; set; }
Property Value
AreaSeries
Area series list
public AreaSeriesList AreaSeries { get; set; }
Property Value
AutoPadding
Padding for control's edges in PXs. Outer edge or rim of the chart, which encloses ViewXY margins. Will be used when Margins are auto-adjusted.
public Padding AutoPadding { get; set; }
Property Value
AutoSpaceLegendBoxes
Determine if graph margins or space between Segments is automatically calculated due LegendBoxes.
public bool AutoSpaceLegendBoxes { get; set; }
Property Value
AxisLayout
Axis layout
public AxisLayout AxisLayout { get; set; }
Property Value
Bands
Band list
public BandList Bands { get; set; }
Property Value
BarSeries
Bar series list
public BarSeriesList BarSeries { get; set; }
Property Value
BarViewOptions
Bar view options for Bar series
public BarViewOptions BarViewOptions { get; set; }
Property Value
Border
Border Options for ViewXY
public ThinBorderXY Border { get; set; }
Property Value
ChartEventMarkers
Chart event markers
public ChartEventMarkerList ChartEventMarkers { get; set; }
Property Value
ConstantLines
Constant line list
public ConstantLineList ConstantLines { get; set; }
Property Value
DataCursor
Data cursor shows series data value at or near mouse position.
public DataCursorXY DataCursor { get; set; }
Property Value
DigitalLineSeries
DigitalLineSeries line series list.
public DigitalLineSeriesList DigitalLineSeries { get; set; }
Property Value
DropOldEventMarkers
Automatically deletes chart event markers and series event markers, whose x value is less than X-axis minimum. By setting this true, the performance is much better in real-time monitoring applications.
public bool DropOldEventMarkers { get; set; }
Property Value
DropOldSeriesData
Automatically deletes series data, whose x value is less than X-axis minimum. By setting this true, the performance is much better in real-time monitoring applications.
public bool DropOldSeriesData { get; set; }
Property Value
FreeformPointLineSeries
FreeformPointLine series list
public FreeformPointLineSeriesList FreeformPointLineSeries { get; set; }
Property Value
HighLowSeries
High-low series list
public HighLowSeriesList HighLowSeries { get; set; }
Property Value
ImageLayers
ViewXY ImageLayers.
public ImageLayerList ImageLayers { get; set; }
Property Value
IntensityGridSeries
List of evenly spaced intensity grid series
public IntensityGridSeriesList IntensityGridSeries { get; set; }
Property Value
IntensityMeshSeries
List of intensity mesh series
public IntensityMeshSeriesList IntensityMeshSeries { get; set; }
Property Value
LegendBoxes
ViewXY LegendBoxes.
public LegendBoxXYList LegendBoxes { get; set; }
Property Value
LineCollections
Line segment collection list
public LineCollectionList LineCollections { get; set; }
Property Value
LineSeriesCursors
LineSeriesCursors
public LineSeriesCursorList LineSeriesCursors { get; set; }
Property Value
LiteFreeformLineSeries
LiteFreeformLineSeries line series list.
public LiteFreeformLineSeriesList LiteFreeformLineSeries { get; set; }
Property Value
LiteLineSeries
LiteLineSeries line series list.
public LiteLineSeriesList LiteLineSeries { get; set; }
Property Value
Maps
Maps.
public Map Maps { get; set; }
Property Value
PointLineSeries
PointLine series list
public PointLineSeriesList PointLineSeries { get; set; }
Property Value
PolygonSeries
Polygon series list
public PolygonSeriesList PolygonSeries { get; set; }
Property Value
SampleDataBlockSeries
SampleDataBlockSeries line series list.
public SampleDataBlockSeriesList SampleDataBlockSeries { get; set; }
Property Value
SampleDataSeries
Sampled data point line series list
public SampleDataSeriesList SampleDataSeries { get; set; }
Property Value
StockSeries
Stock data series list
public StockSeriesList StockSeries { get; set; }
Property Value
TitlesAutoPlacement
Automatic title placement settings.
public AutoLabelLocator TitlesAutoPlacement { get; set; }
Property Value
UseMultithreadingForBlockSeries
Use multithreading for block series types.
public bool UseMultithreadingForBlockSeries { get; set; }
Property Value
XAxes
X Axes list
public AxisXList XAxes { get; set; }
Property Value
YAxes
Y Axes list
public AxisYList YAxes { get; set; }
Property Value
ZoomPanOptions
Zoom, pan and auto-fit options
public ZoomPanOptions ZoomPanOptions { get; set; }
Property Value
Methods
CalculateMinMaxCoordinatesFromUserInteractiveDeviceLocation(int, int, int, int, out int, out int, out int, out int)
Calculate minimum and maximum cordinates from user interactive device location.
protected bool CalculateMinMaxCoordinatesFromUserInteractiveDeviceLocation(int startX, int stopX, int startY, int stopY, out int minX, out int maxX, out int minY, out int maxY)
Parameters
startXintZoom start mouse position X coordinate.
stopXintZoom stop mouse position X coordinate.
startYintZoom start mouse position Y coordinate.
stopYintZoom stop mouse position Y coordinate.
minXintX-minimum coordinate based on zoom mode.
maxXintX-maximum coordinate based on zoom mode.
minYintY-minimum coordinate based on zoom mode.
maxYintY-maximum coordinate based on zoom mode.
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.CalculateMinMaxCoordinatesFromUserInteractiveDeviceLocation(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32@,System.Int32@,System.Int32@,System.Int32@)
CancelRectangleZooming()
Cancel rectangle zooming.
public void CancelRectangleZooming()
ClearZoomStack()
Clear zoom stack.
public void ClearZoomStack()
CreateDefaultLegendBoxes()
Create default LegendBox and add to list of LegendBoxes.
public static LegendBoxXYList CreateDefaultLegendBoxes()
Returns
- LegendBoxXYList
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.CreateDefaultLegendBoxes
CreateDefaultXAxes()
Create default X-Axis and add to list of X-axes.
public static AxisXList CreateDefaultXAxes()
Returns
- AxisXList
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.CreateDefaultXAxes
CreateDefaultYAxes()
Create default Y-Axis and add to list of Y-axes.
public static AxisYList CreateDefaultYAxes()
Returns
- AxisYList
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.CreateDefaultYAxes
CreateZoomPanOptions()
Create new Zoom pan options
protected override void CreateZoomPanOptions()
DeviceButtonClicked(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)
Mouse button has been clicked.
protected override bool DeviceButtonClicked(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) chartLightningChartparam chart M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonClicked(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
DeviceButtonDown(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)
User interactive device button has been clicked down.
protected override bool DeviceButtonDown(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) chartLightningChartparam chart M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonDown(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
DeviceButtonUp(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)
User interactive device button has been released.
protected override bool DeviceButtonUp(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) chartLightningChartparam chart M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.DeviceButtonUp(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
Dispose(bool)
Clean up any resources being used.
protected override void Dispose(bool disposing)
Parameters
disposingbooltrue if managed resources should be disposed, otherwise false.
EnableParallelComputationForSampleDataBlockSeries(bool)
Enable parallel computation for SampleDataBlockSeries. Performance varies depending on hardware and sample count. Prefer parallelization, when series point count is high and there are multiple series.
public void EnableParallelComputationForSampleDataBlockSeries(bool enable)
Parameters
enableboolEnable or disable parallelization.
FreeZoomDrawData()
Free all zoom draw data
protected override void FreeZoomDrawData()
Get2DDataSeries()
Gets list of all series added into SampleDataSeries, PointLineSeries, FreeformPointLineSeries, AreaSeries and HighLowSeries.
public IList<PointLineSeriesBase> Get2DDataSeries()
Returns
- IList<PointLineSeriesBase>
List of series
Get2DSeriesEnumerator()
Get Enumerator of 2D Series.
public IEnumerator<SeriesBaseXY> Get2DSeriesEnumerator()
Returns
- IEnumerator<SeriesBaseXY>
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.Get2DSeriesEnumerator
GetAll2DSeries()
Gets all series
public IList<SeriesBaseXY> GetAll2DSeries()
Returns
- IList<SeriesBaseXY>
List of series
GetAllHighLowSeries()
Get list of all highlow series.
public IList<HighLowSeriesBase> GetAllHighLowSeries()
Returns
- IList<HighLowSeriesBase>
List of highlow series
GetAllIntensitySeries()
Get list of all intensity series
public IList<IntensitySeriesBase> GetAllIntensitySeries()
Returns
- IList<IntensitySeriesBase>
List of series
GetAllLineCollectionSeries()
Gets list of all series added into LineCollection.
public IList<LineCollection> GetAllLineCollectionSeries()
Returns
- IList<LineCollection>
List of series
GetAllLineSeries()
Gets list of all series added into SampleDataSeries, PointLineSeries and FreeformPointLineSeries
public IList<PointLineSeriesBase> GetAllLineSeries()
Returns
- IList<PointLineSeriesBase>
List of series
GetAllTriggableLineSeries()
Gets list of all triggable series.
public IList<ILevelTriggable> GetAllTriggableLineSeries()
Returns
- IList<ILevelTriggable>
List of series
GetGraphSegmentInfo()
Gets graph segment info (in PX). Useful when multiple Y-axes are defined and user need to know where the graph segment boundaries are.
public GraphSegmentInfo GetGraphSegmentInfo()
Returns
- GraphSegmentInfo
Graph segment info.
GetHighLowSeriesOfAxisX(AxisX)
Get list of highlow series belonging to given X axis
public IList<HighLowSeriesBase> GetHighLowSeriesOfAxisX(AxisX axisX)
Parameters
axisXAxisXparam axisX M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.GetHighLowSeriesOfAxisX(LightningChartLib.WinForms.Charting.Axes.AxisX)
Returns
- IList<HighLowSeriesBase>
List of highlow series
GetIntensitySeriesOfAxisX(AxisX)
Get list of all intensity series bound to given axis
public IList<IntensitySeriesBase> GetIntensitySeriesOfAxisX(AxisX axisX)
Parameters
axisXAxisXX axis
Returns
- IList<IntensitySeriesBase>
List of series
GetLineSeriesOfAxisX(AxisX)
Gets list of series added into SampleDataSeries, PointLineSeries and FreeformPointLineSeries, belonging to given X axis.
public IList<PointLineSeriesBase> GetLineSeriesOfAxisX(AxisX axisX)
Parameters
axisXAxisXparam axisX M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.GetLineSeriesOfAxisX(LightningChartLib.WinForms.Charting.Axes.AxisX)
Returns
- IList<PointLineSeriesBase>
List of series
GetPersistentSeriesRenderingLayers()
Get persistent series rendering layers and its descendant objects list.
public List<PersistentSeriesRenderingLayerBase> GetPersistentSeriesRenderingLayers()
Returns
- List<PersistentSeriesRenderingLayerBase>
List of persistent series rendering layers.
GetSeriesOfAxisX(AxisX)
Get list of series having the given X-axis assigned.
public IList<SeriesBaseXY> GetSeriesOfAxisX(AxisX axisX)
Parameters
axisXAxisXX-axis.
Returns
- IList<SeriesBaseXY>
List of series.
GetSeriesOfAxisY(AxisY)
Get list of series having the given Y-axis assigned.
public IList<SeriesBaseXY> GetSeriesOfAxisY(AxisY axisY)
Parameters
axisYAxisYY-axis.
Returns
- IList<SeriesBaseXY>
List of series.
GetValidZoomDirection()
Determine the direction of zooming.
protected RectangleZoomMode GetValidZoomDirection()
Returns
- RectangleZoomMode
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.GetValidZoomDirection
GetYAxesInSegment(int)
Get list of Y-axes which are in segment index given.
public IList<AxisY> GetYAxesInSegment(int segmentIndex)
Parameters
segmentIndexintSegment index.
Returns
GetZoomPadding()
Getter of the ZoomPadding, supported by Round and 3D Views ZoomPanOptions.
As ViewXY does not support ZoomPadding, this method always returns empty (default) padding.
protected override Padding GetZoomPadding()
Returns
- Padding
ZoomPadding of the given view, if supported.
HandleMarginsChanged()
Handler gets Graph segment information
protected override void HandleMarginsChanged()
HandlePaddingChange()
protected virtual void HandlePaddingChange()
IsPositionOverGraphArea(int, int)
Finds out if the given position is over graph area (input in DIPs).
public bool IsPositionOverGraphArea(int x, int y)
Parameters
Returns
- bool
True if is over
Pan(int, int)
Pan the view.
public void Pan(int deltaX, int deltaY)
Parameters
PositionOverGraph(CoordXY)
Check is position over graph.
protected override bool PositionOverGraph(CoordXY coord)
Parameters
coordCoordXYPosition
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.PositionOverGraph(LightningChartLib.WinForms.Charting.CoordXY)
ToString()
Convert class description to string.
public override string ToString()
Returns
- string
Class description as a string.
UserInteractiveDeviceMoved(UserInteractiveDeviceEventArgs, UserInteractiveDeviceEventType, LightningChart)
User interactive device has been moved.
protected override bool UserInteractiveDeviceMoved(UserInteractiveDeviceEventArgs eventArguments, UserInteractiveDeviceEventType eventType, LightningChart chart)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) eventTypeUserInteractiveDeviceEventTypeparam eventType M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart) chartLightningChartparam chart M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.UserInteractiveDeviceMoved(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventType,LightningChartLib.WinForms.Charting.LightningChart)
WheelScrolled(UserInteractiveDeviceEventArgs, LightningChart)
User interactive device wheel has been been scrolled.
public override bool WheelScrolled(UserInteractiveDeviceEventArgs eventArguments, LightningChart chart)
Parameters
eventArgumentsUserInteractiveDeviceEventArgsparam eventArguments M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart) chartLightningChartparam chart M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)
Returns
- bool
returns M:LightningChartLib.WinForms.Charting.Views.ViewXY.ViewXY.WheelScrolled(LightningChartLib.WinForms.Charting.UserInteractiveDeviceEventArgs,LightningChartLib.WinForms.Charting.LightningChart)
Zoom(int, int, int, int)
Zoom the chart in or out. The input parameters in screen coordinates (pixels). If stop point X is greater than start point X, zooms in. If stop point X is less than start point X, fits the view.
public void Zoom(int startX, int startY, int stopX, int stopY)
Parameters
startXintZoom start point X, in pixels.
startYintZoom start point Y, in pixels.
stopXintZoom stop point X, in pixels.
stopYintZoom stop point Y, in pixels.
ZoomByFactor(PointInt, double, bool, bool, bool)
Zooms in by factor.
public void ZoomByFactor(PointInt zoomCenterCoord, double zoomFactor, bool zoomX, bool zoomY, bool UseDIP = true)
Parameters
zoomCenterCoordPointIntZoom center coordinate, default input in DIPs, zooming is made around it. Coordinate must hit the graph area (area between graph margins).
zoomFactordoubleZoom factor over 1 zooms in, factor in range 0...1 zooms out.
zoomXboolApply zoom in X-dimension.
zoomYboolApply zoom in Y-dimension.
UseDIPboolUse DIPs instead of pixels as parameters.
ZoomOutPopFromStack()
Zoom out from stack.
public void ZoomOutPopFromStack()
ZoomToFit()
View autoscale. Fits all axes so that all series data is shown.
public void ZoomToFit()
Events
BeforePanning
Panning is about to start.
public event ViewXY.BeforePanningEventHandler BeforePanning
Event Type
BeforeZooming
Zooming is about to start.
public event ViewXY.BeforeZoomingEventHandler BeforeZooming
Event Type
Panned
Panning has ended.
public event ViewXY.PannedEventHandler Panned
Event Type
YAxisGapChanged
Occurs when the y-axis gap is reduced to zero, if y-axes do not fit with applied gap to graph area.
public event ViewXY.YAxisGapChangedEventHandler YAxisGapChanged
Event Type
Zoomed
Zooming has ended.
public event ViewXY.ZoomedEventHandler Zoomed