Click or drag to resize

SurfaceSeries3DBase Class

LightningChart .NET Help
Surface series base.
Inheritance Hierarchy

Namespace:  Arction.WinForms.Charting.Series3D
Assembly:  Arction.WinForms.Charting.LightningChart (in Arction.WinForms.Charting.LightningChart.dll) Version: 10.3.1
Syntax
[SerializableAttribute]
public class SurfaceSeries3DBase : SeriesBase3D

The SurfaceSeries3DBase type exposes the following members.

Constructors
  NameDescription
Public methodSurfaceSeries3DBase
Constructor
Top
Properties
  NameDescription
Public propertyAllowCellTrace
Allow tracing of the surface cell when user interactive device is over.
Public propertyAllowUserInteraction
Gets or sets whether allow user interaction.
(Inherited from UserInteractiveObject.)
Public propertyBaseColor
Base color for filling.
Public propertyColorSaturation
Surface fill color saturation. High value gives brighter colors.
Public propertyContourLineColor
Contour line color.
Public propertyContourPalette
Color palette for Y value information.
Public propertyData
Series 3D point data.
Public propertyDisableDepthTest
Disable depth buffer test. Disabling this improves performance, but may cause erroneous painting order of objects.
Public propertyFadeAway
Fade away surface/waterfall towards back (higher data row numbers), with given percent. Valid range is from 0(no fadeaway) to 100 (full fadeaway).
Public propertyFastContourZoneHeight
Height (Y-axis value range) for fast contour zones. The fast contour zone is a contour line equivalent.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code.
(Inherited from HighlightingItemBase.)
Public propertyIncludeInAutoFit
Include in autofit.
(Inherited from SeriesBase3D.)
Public propertyInitialValue
Initial value for data Y. Clears the series. It is applied when creating or resizing Data array.
Public propertyMaterial
Series material
(Inherited from SeriesBase3D.)
Public propertyOwnerView
Owner view
(Inherited from SeriesBase3D.)
Public propertyRenderingOrder
Drawing order related to PointLineSeries.
Public propertyShowInLegendBox
Enlists the series title text in Legend box of the chart
(Inherited from SeriesBase3D.)
Public propertySizeX
Grid size in X dimension (Data array columns).
Public propertySizeZ
Grid size in Z dimension (Data array rows).
Public propertySuppressLighting
Suppress all light calculations on this surface series.
Public propertyTitle
Series title
Public propertyToneColor
Solid fill tone color
Public propertyWireframeLineStyle
Wireframe line style.
Public propertyWireframeOffset
Wireframe shift amount from fill. Keep some amount of shift, to avoid 3D render engine Z buffer fighting.
Public propertyVisible
Is the series visible
(Inherited from SeriesBase3D.)
Public propertyXAxisBinding
X axis binding
(Inherited from SeriesBase3D.)
Public propertyYAxisBinding
Y axis binding
(Inherited from SeriesBase3D.)
Public propertyZAxisBinding
Z axis binding
(Inherited from SeriesBase3D.)
Top
Methods
  NameDescription
Public methodCheckSurfaceSizeForGPU
Check if the given surface size can be used with the GPU. GPU index buffer capacity is verified.
Public methodClear
Clears the series by setting Data Y values to InitialValues. Sets the data point colors to BaseColor.
(Overrides SeriesBase3DClear.)
Public methodCreateNewDataArray
Create new data array.
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetDataColor
Get color from Data array value.
Public methodGetDataValue
Get value from Data array value.
Public methodGetDataXValue
Get Data array X value.
Public methodGetDataYValue
Get Data array Y value.
Public methodGetDataZValue
Get Data array Z value.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMinMaxValues
Get series minimum and maximum data values.
(Inherited from SeriesBase3D.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetXAxis
Get X axis object to which this series is bound to
(Inherited from SeriesBase3D.)
Public methodGetYAxis
Get Y axis object to which this series is bound to
(Inherited from SeriesBase3D.)
Public methodGetZAxis
Get Z axis object to which this series is bound to
(Inherited from SeriesBase3D.)
Public methodInvalidateData
Series data has been modified directly by it's array. Use this method to notify chart that this series needs a refresh
(Inherited from SeriesBase3D.)
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsPositionOver(Int32, Int32, Boolean)
Is position over series.
(Inherited from SeriesBase3D.)
Public methodIsPositionOver(Int32, Int32, Int32, Int32, Boolean)
Detect if position is over the series. Also solves the column and row index where position is over of.
Public methodLoadFromCSV
Loads series data from a CSV file.
(Overrides SeriesBase3DLoadFromCSV(String, SeparatorCSV).)
Public methodRefreshRenderingData
Rebuilds rendering data. Expert's method for allowing multi-threaded application to pre-build rendering data before rendering stage. Rendering stage must always be synchronized to main thread, but this call can be called parallel for every series of this type.
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodSaveToCSV
Saves series data into CSV file.
(Overrides SeriesBase3DSaveToCSV(String, SeparatorCSV).)
Public methodSetDataValue
Set data values from X, Y, Z and color.
Public methodSetHeightDataFromBitmap
Create data based on bitmap file contents. Data array will have dimensions of the bitmap Width X Height. Use options to reduce resolution and smooth it if needed. Height data of is calculated for each pixel from R, G, and B sum. 0 (black) will have the minimum value, and maximum value is obtained from 3*255 (white). If bitmap has alpha value of 0, the data is set to -INF, and the value is not drawn.
Public methodSetHighlight
Highlights the object.

This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set.

(Inherited from HighlightingItemBase.)
Public methodSetProperCursor
Set proper drag cursor. Default is hand.
(Inherited from UserInteractiveObject.)
Public methodSetSize
Set grid size, both X and Z at same time. If you already have a large existing data, using this method is faster than setting SizeX and SizeZ separately.
Public methodSolveNearestDataPointByCoord
Solve nearest data point to given screen coordinate [input in DIP]. Takes the data point distance from camera into account. Only solves the point when coordinate is over the surface.
Public methodToString
Item to string.
(Overrides SeriesBase3DToString.)
Top
Events
  NameDescription
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Public eventTraceCellChanged
Occurs when the user interactive device has been moved over to a different surface series cell.
Top
Fields
  NameDescription
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Top
See Also