ISProfile.GetReferenceSeriesCollection

Description

This function returns the reference series collection.

Syntax

object.GetReferenceSeriesCollection()

Part Attribute Type Description
object Required
The object always implements the ISProfile interface

Return Value

ISReferenceSeriesCollection

Returns the reference series collection.

Example

Display the number of reference series, the number of sub series and some information about them.

Dim aReferenceSeriesCollection
Dim aReferenceSeries
Dim aRefSeriesSubSeries
Dim aData
Dim aValuesStr, aValuesMaxStr, aValuesMinStr  
Dim aMessage
Dim i, j, k     

Set aReferenceSeriesCollection = Profile.GetReferenceSeriesCollection

aMessage = "Reference Series Count = " & aReferenceSeriesCollection.Count & vbNewLine

for i = 0 to aReferenceSeriesCollection.Count - 1
  set aReferenceSeries = aReferenceSeriesCollection.Item (i)
  aMessage = aMessage & vbNewLine & (i + 1) & ") " &_
    "Series Name: " & aReferenceSeries.SeriesName & " (" &_
    "Sub Series Count = " & aReferenceSeries.SubSeriesCount & ")" & vbNewLine 
  
  for j = 0 to aReferenceSeries.SubSeriesCount - 1
    set aRefSeriesSubSeries = aReferenceSeries.SubSeries(j)
    
    set aData = aRefSeriesSubSeries.Data
    aValuesStr = ""
    aValuesMaxStr = ""
    aValuesMinStr = ""
     
    for k = 0 to aData.Count - 1
      aValuesStr = aValuesStr & aData.Values(k) & ", "
      aValuesMaxStr = aValuesMaxStr & aData.ValuesMax(k) & ", "
      aValuesMinStr = aValuesMinStr & aData.ValuesMin(k) & ", "  
    next 'k  
      
    aMessage = aMessage & (i + 1) & "." & (j + 1) &_
      " Sub Series Name: " & aRefSeriesSubSeries.Name & vbNewLine &_
      "      ID: " & aRefSeriesSubSeries.ID & vbNewLine &_
      "      Data Count: " & aData.Count & vbNewLine &_
      "      Values: " & aValuesStr & vbNewLine &_
      "      Values Max: " & aValuesMaxStr & vbNewLine &_
      "      Values Min: " & aValuesMinStr & vbNewLine  
  next 'j        
next 'i 

Profile.MsgBox(aMessage)   
Note:

In Profile Client v8 on User Interface Reference Series can be found in Maintain > Reference Series.

Version information

Added in v7.8.0