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

  Name Description
Public Constructor Series Constructor Overloaded.  Initializes a new instance of the Series class with a name and the specified Elements.  
Top

Public Properties

  Name Description
Public Property Background Gets or sets the background object used to fill a gauge face or radar associated with this series.  
Public Property CommandTimeout Gets or sets the wait time before terminating the attempt to execute a command and generating an error.  
Public Property ConnectionString Sets the database connection string used when dynamically obtaining charting data from a SQL statement.  
Public Property Data 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 Property DataFields Gets or sets a value that specifies the 'database column' to 'chart data' relationship.  
Public Property DataProviderType Specifies a database type. Defaults to OleDb (Access database).  
Public Property DefaultElement Gets or sets the an Element object whose properties will trickle to all elements within this series.  
Public Property Element Gets or sets an Element object which facilitates a shortcut for adding elements to the chart.  
Public Property Elements Gets or sets a collection of Element objects associated with this series.  
Public Property EmptyElement Gets or sets an EmptyElement object associated with this series.  
Public Property EndDate The ending date used with SqlStatement to query filtered data from a database.  
Public Property GaugeBorderBox Gets or sets a box object that determines the box style and colors used with GaugeBorderShape.UseBox.  
Public Property GaugeBorderShape Gets or sets the GaugeBorderShape of this series used with gauges.  
Public Property GaugeLinearStyle Gets or sets the GaugeLinearStyle used with GaugeType.Horizontal and GaugeType.Vertical.  
Public Property GaugeType Get or sets the GaugeType used with ChartType.Gauges.  
Public Property HatchStylePalette Gets or sets the hatch style palette used be the Elements of this series.  
Public Property HatchStylePaletteName 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 Property ImageBarSyncToValue 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 Property ImageBarTemplate Gets or sets the path and file name of the image bar template used when drawing elements of this series.  
Public Property Item Gets or sets an Element of this Series at a specified index.  
Public Property LegendEntry Gets or sets the legend entry properties of this series.  
Public Property Limit Gets or sets the limit number of elements returned for this series when data is generated.  
Public Property LimitMode Determine the type of limitation for Limit and SplitByLimit properties. Default is Top.  
Public Property Line Gets or sets the line properties of this series.  
Public Property Name Gets or sets the name of this series.  
Public Property OtherElementText Controls the label used for the aggregated datapoint / series created when using Limit or SplitByLimit and setting ShowOther to true.  
Public Property Palette Gets or sets the palette which will be used by the Elements of this series.

Note If used, legend behavior will be different.  
Public Property PaletteName 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 Property ParameterCollection Gets or sets a collection of Parameter objects used in conjunction with StoredProcedure  
Public Property Position Gets or sets the position of this series in relation to other series when the chart is drawn.  
Public Property ShowOther 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 Property SplineTensionPercent Gets or sets a value between 0 and 100 that specifies the tension of a spline curve.  
Public Property SplitByLimit Gets or sets the number of series created using SplitBy.  
Public Property SqlStatement The SQL statement used to obtain the charting data.  
Public Property StartDate The starting date used with SqlStatement to query filtered data from a database.  
Public Property StoredProcedure 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 Property TotalElements Return the total number of elements in the elements collection. This property usually used in conjunction with Limit.  
Public Property Type Gets or sets the type of this series.  
Public Property Visible Gets or sets a value which indicates whether the series is visible.  
Public Property XAxis Gets or sets the x axis for this series.  
Public Property YAxis Gets or sets the y axis for this series.  
Top

Public Methods

  Name Description
Public Methodstatic (Shared in Visual Basic) Add Overloaded.  Adds two Series objects together.  
Public Method AddElements Overloaded. Adds the elements of the specified series to this series.  
Public Method AddParameter Adds a stored procedure when to use in conjunction with StoredProcedure.  
Public Method Calculate Performs a Calculation on current instance of this series.  
Public Methodstatic (Shared in Visual Basic) Divide Overloaded.  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) FromYValues Overloaded. Creates a named series of element with the specified y values.  
Public Method GetDataSource Gets a DataSource object representing this Series.  
Public Method GetSmartPalette Overloaded.  Generates a SmartPalette object that contains the names of the elements in this Series matched with the specified Palette enumeration.  
Public Methodstatic (Shared in Visual Basic) Multiply Overloaded.  Multiplies two Series objects together.  
Public Method Sort Overloaded. Sorts the Elements based on an element property and order.  
Public Method Split Splits the elements into individual series per the specified TimeIntervalAdvanced.  
Public Method SplitByName Overloaded. Splits a series to multiple series based on element subvalue's name.  
Public Method SplitRegroup Splits 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 Method SplitRegroupCalculate Overloaded. Splits 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 Methodstatic (Shared in Visual Basic) Subtract Overloaded.  Subtracts the element values of series on the right from the series on the left.  
Public Method Trim Overloaded.  Trims elements out of this series based on a specified numeric range and element property.  
Top

Public Operators

Public Operator Addition Overloaded.  Adds two Series objects together.
Public Operator Division Overloaded.  Divides the element values of the series on the left by the element values of the series on the right.
Public Operator Multiplication Overloaded.  Multiplies two Series objects together.
Public Operator Subtraction Overloaded.  Subtracts the element values of series on the right from the series on the left.
Top

See Also