WaterfallDataSeries3D<TAllPoints> Class Members
The following tables list the members exposed by WaterfallDataSeries3D<TAllPoints>.
Public Constructors
| Name | Description | |
|---|---|---|
 | WaterfallDataSeries3D<TAllPoints> Constructor | Overloaded. |
Public Fields
| Name | Description | |
|---|---|---|
 | SyncRoot | The Synchronization Object for the DataSeries3D. (Inherited from SciChart.Charting3D.Model.DataSeries3D) |
Protected Fields
| Name | Description | |
|---|---|---|
 | _gridData | (Inherited from SciChart.Charting3D.Model.BaseGridDataSeries3D<TX,TY,TZ>) |
| _isDirty | (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| _yRangeCached | (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
Public Properties
| Name | Description | |
|---|---|---|
 | InternalArray | Accesses the internal array, which is a rectangular array indexed by Z then X (Inherited from SciChart.Charting3D.Model.BaseGridDataSeries3D<TX,TY,TZ>) |
| IsDirty | Gets or sets a value indicating whether this instance is dirty. If dirty, any cached data must be re-calculated. You can set this value to True to force recalculation of caches. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| IsHeightmapDirty | Gets or sets value determining whether the heightmap is dirty. If dirty, cached data must be re-calculated. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| IsMeshDirty | Gets or sets value determining whether the mesh is dirty. If dirty, cached data must be re-calculated. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| IsSuspended | Gets a value indicating whether updates for the target are currently suspended. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| Item | Returns the Y-value at index Z,X (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| ParentSurface | Gets or sets the parent SciChart.Charting3D.ISciChart3DSurface which this SciChart.Charting3D.Model.IDataSeries3D instance is attached to. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| SeriesName | Gets or sets the name of this series. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| StartX | Gets the start X value, that is, the X data-value at this.InternalArray[0, z] (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| StartZ | Gets the start Z value, that is, the Z data-value at this.InternalArray[x, 0] (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| StepX | Gets the step-X value, that is, the data-value size between each element in the grid in the X-direction (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| StepZ | Gets the step-Z value, that is, the data-value size between each element in the grid in the Z-direction (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| SyncRoot | Gets an object for thread synchronization purposes (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| XRange | Gets the total extents of the SciChart.Charting3D.Model.IDataSeries3D in the X direction. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| XSize | Gets the X-Size of the Grid (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| YRange | Gets the total extents of the SciChart.Charting3D.Model.IDataSeries3D in the Y direction. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| ZRange | Gets the total extents of the SciChart.Charting3D.Model.IDataSeries3D in the Z direction. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| ZSize | Gets the Z-Size of the grid (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
Public Methods
| Name | Description | |
|---|---|---|
 | Clear | Overloaded. Clears the SciChart.Charting3D.Model.BaseGridDataSeries3D<TX,TY,TZ>, resetting its X,Z size (Inherited from SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| CopyFrom | Overloaded. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| GetBounds | Gets the bounding box for the data (containing XRange, YRange, ZRange). (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| GetRowAt | Returns the row at the specified Z Index (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| GetSelectedRows | Returns a list of Z indices of selected data rows. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| GetX | Computes the X data-value at the specified index (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| GetZ | Computes the Z data-value at the specified index (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| InvalidateParentSurface | May be called to trigger a redraw on the parent SciChart.Charting3D.SciChart3DSurface. This method is extremely useful when SciChart.Charting3D.Model.IDataSeries3D are in a ViewModel and bound via MVVM to SciChart.Charting3D.RenderableSeries.IRenderableSeries3D. Please see the rangeMode parameter for invalidation options. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| OnDataSeriesChanged | Raises the DataSeriesChanged event. May be called by DataSeries3D or by user code to trigger a redraw on the ParentSurface. The event is not raised while SciChart.Core.Framework.ISuspendable.IsSuspended is True. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| PushRow | Overloaded. Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| ResumeUpdates | Resumes updates on the target, intended to be called by SciChart.Core.Framework.IUpdateSuspender. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| SelectRows | Performs selection or deselection of data rows at specified zIndices. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| SetRowAt | Sets the row at the specified Z index (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| SuspendUpdates | Overloaded. Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| To2DArray | Creates a new 2-Dimensional array and fills with values. This can be used for debugging purposes or for interop with other types. Changing the values here does *not* change the GridPointSeries3D (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| ToPointSeries<TPointSeries> | Converts a DataSeries to a SciChart.Charting3D.Model.IPointSeries3D derived type, for use during the render pass. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
Protected Methods
| Name | Description | |
|---|---|---|
 | CreateUpdateSuspender | (Inherited from SciChart.Charting3D.Model.HeightmapBasedDataSeries3D) |
| MarkIsDirtyOnResumeUpdates | (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| OnIsHeightmapDirtyChanged | Invoked right after Dirty State changed to indicated that the heightmap is invalid. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| OnIsMeshDirtyChanged | Invoked right after Dirty State changed to indicated that the mesh is invalid. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
| OnPropertyChanged | Overloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
Extension Methods
| Name | Description | |
|---|---|---|
 | DebugFinalizer<T> | Notifies that finalizer has been invoked |
| ToDoubleArray | Overloaded. Converts an System.IComparable array to double array |
| ToEnumerable<T> | Yields a single item, converting it to System.Collections.IEnumerable. |
| ToStringArray2D<T> |
Public Events
| Name | Description | |
|---|---|---|
 | DataSeriesChanged | Event raised whenever points are added to, removed or one or more DataSeries3D properties changes, requiring a redraw of the parent SciChartSurface. (Inherited from SciChart.Charting3D.Model.DataSeries3D) |
| PropertyChanged | Occurs when a property value changes. (Inherited from WaterfallDataSeries3D<TAllPoints,TAllPoints,TAllPoints>) |
See Also