dotnetCHARTING Send comments on this topic.
Series Class Members
See Also  Properties  Methods 
dotnetCHARTING Namespace : Series Class


The following tables list the members exposed by Series.

Public Constructors

 NameDescription
Public ConstructorSeries ConstructorOverloaded.  Initializes a new instance of the Series class with a name and the specified Elements.  
Top

Public Properties

 NameDescription
Public PropertyBackground Gets or sets the background object used to fill a gauge face or radar associated with this series.  
Public PropertyBox Gets or sets a box object that determines the box style and colors used with GaugeBorderShape.UseBox or ChartType.TreeMap.  
Public PropertyCommandTimeoutGets or sets the wait time before terminating the attempt to execute a command and generating an error.  
Public PropertyConnectionString Sets the database connection string used when dynamically obtaining charting data from a SQL statement.  
Public PropertyContourCount Gets or sets the number of contours to draw on a SeriesType.Surface.Contour series.  
Public PropertyData Gets or sets a DataTable, DataSet, DataView, XML file name, XML string, or an object that implement IEnumerable, ArrayList or HashTable used to generate a SeriesCollection.  
Public PropertyDataFieldsGets or sets a value that specifies the 'database column' to 'chart data' relationship.  
Public PropertyDataProviderType Specifies a database type. Defaults to OleDb (Access database).  
Public PropertyDefaultElement Gets or sets the an Element object whose properties will trickle to all elements within this series.  
Public PropertyElement Gets or sets an Element object which facilitates a shortcut for adding elements to the chart.  
Public PropertyElements Gets or sets a collection of Element objects associated with this series.  
Public PropertyEmptyElement Gets or sets an EmptyElement object associated with this series.  
Public PropertyEndDate The ending date used with SqlStatement to query filtered data from a database.  
Public PropertyExcludeFromAxisRange Gets or sets a value that indicates whether the element values of this series will affect the value axis they are plotted against.  
Public PropertyGaugeBorderBox Gets or sets a box object that determines the box style and colors used with GaugeBorderShape.UseBox.  
Public PropertyGaugeBorderShape Gets or sets the GaugeBorderShape of this series used with gauges.  
Public PropertyGaugeLinearStyle Gets or sets the GaugeLinearStyle used with GaugeType.Horizontal and GaugeType.Vertical.  
Public PropertyGaugeTypeGet or sets the GaugeType used with ChartType.Gauges.  
Public PropertyHatchStylePalette Gets or sets the hatch style palette used be the Elements of this series.  
Public PropertyHatchStylePaletteName Gets or sets a Palette boolean which indicates which static palette will be used be the Elements of this series.
Note If used, legend behavior will be different.  
Public PropertyImageBarSyncToValue Gets or sets a value that indicates whether repeating ImageBar templates will sync the number of times they repeat with the element's value.  
Public PropertyImageBarTemplate Gets or sets the path and file name of the image bar template used when drawing elements of this series.  
Public PropertyInterpolationFillFactor Gets or sets the factor by which a surface element tile is interpolated. This property is used with SeriesTypeSurface.Surface series.  
Public PropertyItem Gets or sets an Element of this Series at a specified index.  
Public PropertyJsID Gets or sets the ID of this series used in JSCharting. By specifying this ID, the series can be referenced in JS.  
Public PropertyJsMap  
Public PropertyLegendEntry Gets or sets the legend entry properties of this series.  
Public PropertyLimit Gets or sets the limit number of elements returned for this series when data is generated.  
Public PropertyLimitMode Determine the type of limitation for Limit and SplitByLimit properties. Default is Top.  
Public PropertyLine Gets or sets the line properties of this series.  
Public PropertyName Gets or sets the name of this series.  
Public PropertyOtherElementText Controls the label used for the aggregated datapoint / series created when using Limit or SplitByLimit and setting ShowOther to true.  
Public PropertyPalette Gets or sets the palette which will be used by the Elements of this series.

Note If used, legend behavior will be different.  
Public PropertyPaletteName Gets or sets a Palette enumeration which indicates which static palette will be used by the Elements of this series.

Note If used, legend behavior will be different.  
Public PropertyParameterCollection Gets or sets a collection of Parameter objects used in conjunction with StoredProcedure  
Public PropertyPosition Gets or sets the position of this series in relation to other series when the chart is drawn.  
Public PropertyShapeLabels (JS Chart Only) A collection of labels used with gauge charts.  
Public PropertyShowOther This property controls if the additional series not shown due to the use of SplitByLimit, or the additional elements not shown due to the use of Limit are aggregated into a single series / element and graphed alongside the top x series / elements.  
Public PropertySplineTensionPercent Gets or sets a value between 0 and 100 that specifies the tension of a spline curve.  
Public PropertySplitByLimitGets or sets the number of series created using SplitBy.  
Public PropertySqlStatement The SQL statement used to obtain the charting data.  
Public PropertyStartDate The starting date used with SqlStatement to query filtered data from a database.  
Public PropertyStoredProcedure This property accepts the name of a stored procedure to be used in place of the SqlStatement property in order to obtain data for the chart.  
Public PropertyTotalElements Return the total number of elements in the elements collection. This property usually used in conjunction with Limit.  
Public PropertyTypeGets or sets the type of this series.  
Public PropertyUse3D Gets or sets a value that indicates whether this surface series is drawn in 3D.  
Public PropertyVisible Gets or sets a value which indicates whether the series is visible.  
Public PropertyXAxis Gets or sets the x axis for this series.  
Public PropertyYAxis Gets or sets the y axis for this series.  
Public PropertyZAxisGets or sets the Z axis of this series when used with surface charts.  
Top

Public Methods

 NameDescription
Public Methodstatic (Shared in Visual Basic)AddOverloaded.  Adds two Series objects together.  
Public MethodAddElementsOverloaded. Adds the elements of the specified series to this series.  
Public MethodAddParameter Adds a stored procedure when to use in conjunction with StoredProcedure.  
Public MethodCalculateOverloaded.   
Public Methodstatic (Shared in Visual Basic)DivideOverloaded.  Divides the element values of the series on the left by the element values of the series on the right.  
Public Methodstatic (Shared in Visual Basic)FromSurfaceData Constructs a series containing surface data created from the specified value arrays.  
Public Methodstatic (Shared in Visual Basic)FromYValuesOverloaded.   
Public MethodGetDataSource Gets a DataSource object representing this Series.  
Public MethodGetElementBreadcrumbsOverloaded.   
Public MethodGetInterpolatedXValueCalculates the interpolated X value of this series given the Y value.  
Public MethodGetInterpolatedYValueCalculates the interpolated Y value of this series given the X value.  
Public MethodGetSmartPaletteOverloaded.   
Public MethodGetSurfaceData Groups the time based elements by the specified time interval and returns a series with surface data. This method also populates a list of dates when can be mapped to the x axis of the chart.  
Public MethodGetValueList Gets a string containing a comma delimited list of the specified values for each element.  
Public MethodGetYValueList Gets a string containing a comma delimited list of Y values.  
Public Methodstatic (Shared in Visual Basic)MultiplyOverloaded.  Multiplies two Series objects together.  
Public MethodSelectiveElementDefaultsOverloaded.   
Public MethodSortOverloaded.   
Public MethodSplit Splits the elements into individual series per the specified TimeIntervalAdvanced.  
Public MethodSplitByNameOverloaded. Splits a series to multiple series based on element subvalue's name.  
Public MethodSplitRegroupSplits the elements based on the first split, then the resulting series are grouped based on the second split. A simple analogy is a stretch of measuring tape representing a timeline. The tape is cut into sections based on (first split), then the pieces are stacked on top of each other and cut again based on the second split. The resulting stacks are evaluated down to an element based on the specified calculation.

As a real world example, consider you have a series with web site traffic represented by an element for each time the website was visited including a date and time. This method can parse the data in a way that allows determining the traffic for each day of the week throughout the entire span of time. This means all the traffic going through the website on any monday would be calculated down to a single element, same for tuesday and so on.

This illustration shows how the data is arranged.

 

Public MethodSplitRegroupCalculateOverloaded.   
Public Methodstatic (Shared in Visual Basic)SubtractOverloaded.  Subtracts the element values of series on the right from the series on the left.  
Public MethodTrimOverloaded.   
Top

Public Operators

Public Operator Addition Overloaded.  
Public Operator Division Overloaded.  
Public Operator Multiplication Overloaded.  
Public Operator Subtraction Overloaded.  
Top

See Also

© 2018 All Rights Reserved.