Click or drag to resize

SurfaceSeries3DBase Class

LightningChart .NET Help
Surface series base.
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingMVVMChartNode
          Arction.Wpf.ChartingMVVMUserInteractiveObjectInt
            Arction.Wpf.ChartingMVVMUserInteractiveObject
              Arction.Wpf.ChartingMVVMHighlightingItemBase
                Arction.Wpf.ChartingMVVM.Series3DSeriesBase3D
                  Arction.Wpf.ChartingMVVM.Series3DSurfaceSeries3DBase
                    Arction.Wpf.ChartingMVVM.Series3DSurfaceGridSeries3D
                    Arction.Wpf.ChartingMVVM.Series3DSurfaceMeshSeries3D
                    Arction.Wpf.ChartingMVVM.Series3DWaterfallSeries3D

Namespace:  Arction.Wpf.ChartingMVVM.Series3D
Assembly:  Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.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
Gets or sets if allow tracing the surface cell with user interactive device. This is a dependency property.
Public propertyAllowUserInteraction
Gets or sets if user interaction is allowed. This is a dependency property.
(Inherited from UserInteractiveObject.)
Public propertyBaseColor
Gets or sets base color for filling. This is a dependency property.
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyColorSaturation
Gets or sets surface fill color saturation. High value gives brighter colors. This is a dependency property.
Public propertyContourLineColor
Gets or sets contour line color. This is a dependency property.
Public propertyContourPalette
Gets or sets color palette for Y value information. This is a dependency property.
Public propertyData
Gets or sets series 3D point data. This is a dependency property.
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDisableDepthTest
Gets or sets if disable depth buffer test. Disabling this improves performance, but may cause erroneous painting order of objects. This is a dependency property.
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyFadeAway
Gets or sets fade away percent surface/waterfall towards back (higher data row numbers). This is a dependency property. Valid range is from 0(no fadeaway) to 100 (full fadeaway).
Public propertyFastContourZoneHeight
Gets or sets height (Y-axis value range) for fast contour zones. The fast contour zone is a contour line equivalent. This is a dependency property.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property.
(Inherited from HighlightingItemBase.)
Public propertyIncludeInAutoFit
Gets or sets if included in autofit. This is a dependency property.
(Inherited from SeriesBase3D.)
Public propertyInitialValue
Gets or sets initial value for data Y. Clears the series. It is applied when creating or resizing Data array. This is a dependency property.
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyMaterial
Gets or sets series material. This is a dependency property.
(Inherited from SeriesBase3D.)
Public propertyOwnerView
Owner view
(Inherited from SeriesBase3D.)
Public propertyRenderingOrder
Gets or sets drawing order related to PointLineSeries. This is a dependency property.
Public propertyShowInLegendBox
Gets or sets if enlists the series title text in Legend box of the chart. This is a dependency property.
(Inherited from SeriesBase3D.)
Public propertySizeX
Gets or sets grid size in X dimension (Data array columns). This is a dependency property.
Public propertySizeZ
Gets or sets grid size in Z dimension (Data array rows). This is a dependency property.
Public propertySuppressLighting
Gets or sets if suppress all light calculations on this this surface series. This is a dependency property.
Public propertyTitle
Gets or sets series title. This is a dependency property.
Public propertyToneColor
Gets or sets solid fill tone color. This is a dependency property.
Public propertyWireframeLineStyle
Gets or sets wireframe line style. This is a dependency property.
Public propertyWireframeOffset
Gets or sets wireframe shift amount from fill. This is a dependency property. Keep some amount of shift, to avoid 3D render engine Z buffer fighting.
Public propertyVisible
Gets or sets if the series is visible. This is a dependency property.
(Inherited from SeriesBase3D.)
Public propertyXAxisBinding
Gets or sets X axis binding. This is a dependency property.
(Inherited from SeriesBase3D.)
Public propertyYAxisBinding
Gets or sets Y axis binding. This is a dependency property.
(Inherited from SeriesBase3D.)
Public propertyZAxisBinding
Gets or sets Z axis binding. This is a dependency property.
(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 methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.
(Inherited from Freezable.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodCreateNewDataArray
Create new data array.
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetCurrentValueAsFrozen
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
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
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
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 methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
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 methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
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 methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
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 methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
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 methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
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 eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
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 fieldStatic memberAllowCellTraceProperty
Identifies the AllowCellTrace dependency property.
Public fieldStatic memberBaseColorProperty
Identifies the BaseColor dependency property.
Public fieldStatic memberColorSaturationProperty
Identifies the ColorSaturation dependency property.
Public fieldStatic memberContourLineColorProperty
Identifies the ContourLineColor dependency property.
Public fieldStatic memberContourPaletteProperty
Identifies the ContourPalette dependency property.
Public fieldStatic memberDataProperty
Identifies the Data dependency property.
Public fieldStatic memberDisableDepthTestProperty
Identifies the DisableDepthTest dependency property.
Public fieldStatic memberFadeAwayProperty
Identifies the FadeAway dependency property.
Public fieldStatic memberFastContourZoneHeightProperty
Identifies the FastContourZoneHeight dependency property.
Public fieldStatic memberInitialValueProperty
Identifies the InitialValue dependency property.
Public fieldStatic memberRenderingOrderProperty
Identifies the RenderingOrder dependency property.
Public fieldStatic memberSizeXProperty
Identifies the SizeX dependency property.
Public fieldStatic memberSizeZProperty
Identifies the SizeZ dependency property.
Public fieldStatic memberSuppressLightingProperty
Identifies the SuppressLighting dependency property.
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Public fieldStatic memberTitleProperty
Identifies the Title dependency property.
Public fieldStatic memberToneColorProperty
Identifies the ToneColor dependency property.
Public fieldStatic memberWireframeLineStyleProperty
Identifies the WireframeLineStyle dependency property.
Public fieldStatic memberWireframeOffsetProperty
Identifies the WireframeOffset dependency property.
Top
See Also