ISRefSeriesSubSeries.Percentiles

Description

The percentiles related to the sub series of the reference series.

Syntax

object.Percentiles(aIndex)

Part	Attribute	Type	Description
`object`	Required	ISRefSeriesSubSeries	The `object` always implements the ISRefSeriesSubSeries interface
`aIndex`	In, Required	int	The index of the percentile

Restriction: This property is readonly.

Return Value

ISRefSeriesPercentile

Example

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

Dim aReferenceSeriesCollection
Dim aReferenceSeries
Dim aRefSeriesSubSeries
Dim aRefSeriesPercentile
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 & " (" &_
    "SubSeries Count = " & aReferenceSeries.SubSeriesCount & ")" & vbNewLine 
  
  for j = 0 to aReferenceSeries.SubSeriesCount - 1
    set aRefSeriesSubSeries = aReferenceSeries.SubSeries(j)
    aMessage = aMessage  & vbNewLine & (i + 1) & "." & (j + 1) &_
      " Name: " & aRefSeriesSubSeries.Name & " (Percentiles Count = " &_
      aRefSeriesSubSeries.PercentileCount & ")" & vbNewLine
            
    for k = 0 to aRefSeriesSubSeries.PercentileCount - 1
      set aRefSeriesPercentile = aRefSeriesSubSeries.Percentiles(k)
      aMessage = aMessage & (i + 1) & "." & (j + 1) & "." & (k + 1) & ". " &_
        "Percentile Name: " & aRefSeriesPercentile.Name & vbNewLine
    next 'k  
  next 'j        
next 'i 

Profile.MsgBox(aMessage)

Note:

In Profile Client v8 on User Interface Percentiles can be found in Maintain > Reference Series > Open reference series > Sub Series > Open sub series > Percentiles.

Version information

Added in v7.8.0