ILaner.ValuePrefixAttributes

Fore Syntax

ValuePrefixAttributes: ILanerCellAttributes;

Fore.NET Syntax

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

Description

The ValuePrefixAttributes property returns collection of attributes used to form prefix of series observations.

Comments

The prefix is displayed to the left of the series observation. The prefix and observation are separated with the space. Value of the set attribute is used as a prefix value. If several attributes are set, their values are separated via comma.

To set attributes used to form suffix and commend of series observations, use the ILaner.ValueSuffixAttributes and ILaner.CommentAttributes properties.

Fore Example

Executing the example requires that the repository contains a workbook with the WORKBOOK_PREFIX 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;
    PrefixAttr: ILanerCellAttributes;
Begin
    // Get workbook
    mb := MetabaseClass.Active;
    WbkObj := mb.ItemById("WORKBOOK_PREFIX").Edit;
    EaxAn := WbkObj As IEaxAnalyzer;
    Laner := EaxAn.Laner;
    // Get collection of prefix attributes
    PrefixAttr := Laner.ValuePrefixAttributes;
    // Clear collection
    PrefixAttr.Clear;
    // Add the "INDICATOR" attribute to the collection of prefix attributes
    PrefixAttr.Add("INDICATOR", LnAttributeType.Fact);
    // Save changes
    WbkObj.Save;
End Sub UserProc;

After executing the example the prefix defined by the INDICATOR custom series attribute is added for workbook observations.

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;
    PrefixAttr: ILanerCellAttributes;
Begin
    // Get workbook
    mb := Params.Metabase;
    WbkObj := mb.ItemById["WORKBOOK_PREFIX"].Edit();
    EaxAn := WbkObj As IEaxAnalyzer;
    Laner := EaxAn.Laner;
    // Get collection of prefix attributes
    PrefixAttr := Laner.ValuePrefixAttributes;
    // Clear collection
    PrefixAttr.Clear();
    // Add the "INDICATOR" attribute to the collection of prefix attributes
    PrefixAttr.Add("INDICATOR", LnAttributeType.latFact);
    // Save changes
    WbkObj.Save();
End Sub;

See also:

ILaner