ILaner.ValueSuffixAttributes

Fore Syntax

ValueSuffixAttributes: ILanerCellAttributes;

Fore.NET Syntax

ValueSuffixAttributes: Prognoz.Platform.Interop.Laner.ILanerCellAttributes;

Description

The ValueSuffixAttributes property returns collection of the attributes used for forming of suffix of series observations.

Comments

The suffix is displayed to the right of the series observation. The suffix and observation are separated with the space. The specified attribute value is used as suffix value. If several attributes are set, their values are separated via comma.

To set attributes used for forming of prefix and comment of series observations, use the ILaner.ValuePrefixAttributes and ILaner.CommentAttributes properties.

Fore Example

Executing the example requires that the repository contains a workbook wit the WORKBOOK_SUFFIX identifier that contains several series. This workbook must use the time series database that contains mandatory attribute of series with the INDICATOR identifier as a data source.

Add links to the Express, Laner and Metabase system assemblies.

Sub UserProc;
Var
    mb: IMetabase;
    WbkObj: IMetabaseObject;
    EaxAn: IEaxAnalyzer;
    Laner: ILaner;
    SuffixAttr, CommentAttr: ILanerCellAttributes;
Begin
    // Get workbook
    mb := MetabaseClass.Active;
    WbkObj := mb.ItemById("WORKBOOK_SUFFIX").Edit;
    EaxAn := WbkObj As IEaxAnalyzer;
    Laner := EaxAn.Laner;
    // Get collection of suffix attributes
    SuffixAttr := Laner.ValueSuffixAttributes;
    // Clear collection
    SuffixAttr.Clear;
    // Add the "INDICATOR" attribute to the collection of suffix attributes
    SuffixAttr.Add("INDICATOR", LnAttributeType.Fact);
    // Get collection of comment attributes
    CommentAttr := Laner.CommentAttributes;
    // Clear collection
    CommentAttr.Clear;
    // Add the "DT" attribute (date) to the collection of comment attributes
    CommentAttr.Add("DT", LnAttributeType.Value);
    // Save changes
    WbkObj.Save;
End Sub UserProc;

After executing the example the following components are added for workbook observations:

The suffix defined by the INDICATOR custom series identifier.
The comment of series value defined by the DT (date) system observation attribute.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.Laner;
…
Public Shared Sub Main(Params: StartParams);
Var
    mb: IMetabase;
    WbkObj: IMetabaseObject;
    EaxAn: IEaxAnalyzer;
    Laner: ILaner;
    SuffixAttr, CommentAttr: ILanerCellAttributes;
Begin
    // Get workbook
    mb := Params.Metabase;
    WbkObj := mb.ItemById["WORKBOOK_SUFFIX"].Edit();
    EaxAn := WbkObj As IEaxAnalyzer;
    Laner := EaxAn.Laner;
    // Get collection of suffix attributes
    SuffixAttr := Laner.ValueSuffixAttributes;
    // Clear collection
    SuffixAttr.Clear();
    // Add the "INDICATOR" attribute to the collection of suffix attributes
    SuffixAttr.Add("INDICATOR", LnAttributeType.latFact);
    // Get collection of comment attributes
    CommentAttr := Laner.CommentAttributes;
    // Clear collection
    CommentAttr.Clear();
    // Add the "DT" attribute (date) to the collection of comment attributes
    CommentAttr.Add("DT", LnAttributeType.latValue);
    // Save changes
    WbkObj.Save();
End Sub;