SurfaceSeriesBase Class

In This Topic

Abstract base class for the GridSurfaceSeries and MeshSurfaceSeries. This class contains common functionality for the surface series like surface palette management, control of the surface filling style, frame style and appearance, flat surface mode etc.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
<ClassInterfaceAttribute(ClassInterfaceType.AutoDual)>
<TypeConverterAttribute(Xceed.Chart.Core.SeriesBaseConverter)>
<SerializableAttribute()>
Public MustInherit Class SurfaceSeriesBase 
   Inherits SeriesBase

'Usage
 
Dim instance As SurfaceSeriesBase

[ClassInterface(ClassInterfaceType.AutoDual)]
[TypeConverter(Xceed.Chart.Core.SeriesBaseConverter)]
[Serializable()]
public abstract class SurfaceSeriesBase : SeriesBase

Inheritance Hierarchy

System.Object
   Xceed.Chart.Core.SeriesBase
      Xceed.Chart.Core.SurfaceSeriesBase
         Xceed.Chart.Core.GridSurfaceSeries
         Xceed.Chart.Core.MeshSurfaceSeries

Protected Fields

	Name	Description
	m_bAutomaticPalette	This member is reserved for internal use and is not intended to be used directly from your code.
	m_bDrawFlat	This member is reserved for internal use and is not intended to be used directly from your code.
	m_bPaletteFrame	This member is reserved for internal use and is not intended to be used directly from your code.
	m_bSmoothPalette	This member is reserved for internal use and is not intended to be used directly from your code.
	m_bSyncPaletteWithAxisScale	This member is reserved for internal use and is not intended to be used directly from your code.
	m_CustomPalette	This member is reserved for internal use and is not intended to be used directly from your code.
	m_dPositionValue	This member is reserved for internal use and is not intended to be used directly from your code.
	m_FillEffect	This member is reserved for internal use and is not intended to be used directly from your code.
	m_FillStyle	This member is reserved for internal use and is not intended to be used directly from your code.
	m_FrameLine	This member is reserved for internal use and is not intended to be used directly from your code.
	m_FrameStyle	This member is reserved for internal use and is not intended to be used directly from your code.
	m_nPaletteSteps	This member is reserved for internal use and is not intended to be used directly from your code.
	m_PositionMode	This member is reserved for internal use and is not intended to be used directly from your code.
	m_ValueFormat	This member is reserved for internal use and is not intended to be used directly from your code.

Top

Public Properties

	Name	Description
	AutomaticPalette	When set to true the component uses automatically generated surface palette. When set to False the component uses a custom defined palette (the Palette property gives access to the custom palette).
	DrawFlat	Draws the surface in flat mode (contour chart). The PositionMode and PositionValue properties determine the vertical position of the surface.
	EmptyDataPointsAppearance	Gives you access to an instance of the EmptyDataPointsAppearance class controlling the appearance of the empty data points displayed by the series (Inherited from Xceed.Chart.Core.SeriesBase)
	FillEffect	Controls the fill effect applied to the surface. The user can modify the surface filling transparency, material properties like specular color, emissive color, shininess, as well as apply textures, gradients and patterns to the surface.
	FillStyle	Controls the way in which the surface is filled. Currently there are two filling modes: zone filling and no filling.
	FrameLine	Controls the appearance of the surface frame lines and dots.
	FrameStyle	Controls the surface frame style. Supported values are: SurfaceFrameStyle.None - no frame at all SurfaceFrameStyle.Mesh - frame connecting the adjacent data points SurfaceFrameStyle.Contour - contour lines at specific surface elevations SurfaceFrameStyle.MeshContour - mixed mesh and contour frame SurfaceFrameStyle.Dots - dots at the data points
	InflateMargins	Inflates the margins of the series to fit the chart area. (Inherited from Xceed.Chart.Core.SeriesBase)
	Interactivity	Gives you access to the SeriesInteractivity object controlling the interactivity features of the data points.
	Legend	Gives you access to an instance of the SeriesLegend class controlling the representation of the series in the legend. (Inherited from Xceed.Chart.Core.SeriesBase)
	Name	The name of the series. (Inherited from Xceed.Chart.Core.SeriesBase)
	Palette	Gives access to the custom palette associated with the surface. To make the chart use the custom palette you have to set the AutomaticPalette property to false.
	PaletteFrame	When set to true the frame is displayed with the current palette colors (automatic or manual). When set to false the frame is displayed with the line properties accessible with the FrameLine property.
	PaletteSteps	Controls the number of entries in the automatic palette if the SyncPaletteWithAxisScale is set to false. Valid only when AutomaticPalette is set to true.
	PositionMode	The PositionMode property controls the vertical position of the surface, when it is rendered in flat mode (DrawFlat property is set to True).
	PositionValue	The PositionValue property specifies the value for the vertical position of the surface when the DrawFlat property is set to True and the PositionMode is SurfacePositionMode.CustomValue.
	Shadow	Gives access to the Shadow object controlling the shadow of the series. Shadows are visible when the scene is rendered with GDI+. (Inherited from Xceed.Chart.Core.SeriesBase)
	SmoothPalette	When this property is enabled the zone colors gradate smoothly from one to another.
	SyncPaletteWithAxisScale	Synchronizes the number of palette entries in the automatic palette with the current scale of the vertical axis on which the series is displayed. Valid only when AutomaticPalette is set to true. Otherwise the PaletteSteps property is considered.
	ValueFormatting	Gives access to the ValueFormatting object controlling the formatting of the elevation (Y) values.
	Visible	Controls the visibility of the series. (Inherited from Xceed.Chart.Core.SeriesBase)

Top

Public Methods

	Name	Description
	Clone	Creates an identical copy of this series object (Inherited from Xceed.Chart.Core.SeriesBase)
	DisplayOnAxis	Overloaded. Instructs the chart whether to scale the series on one of the standard chart axes. (Inherited from Xceed.Chart.Core.SeriesBase)
	GetDataSeries	Virtual method returning a collection of the data series that the series uses. The included series are controlled with the included and excluded parameters. (Inherited from Xceed.Chart.Core.SeriesBase)
	GetUserControl	Creates a user control which can be used for the visual editing of the series (Inherited from Xceed.Chart.Core.SeriesBase)
	IsDisplayedOnAxis	Overloaded. Queries whether the series is scaled on the specified standard axis. (Inherited from Xceed.Chart.Core.SeriesBase)

Top

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SurfaceSeriesBase Members
Xceed.Chart.Core Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference