IVZLegends.Clear

Fore Syntax

Clear;

Fore.NET Syntax

Clear();

Description

The Clear method entirely clears visualizer legend collection.

Fore Example

Executing the example requires that the repository contains an express report with the EXP identifier. The module containing the example should have links to the Express, Metabase and Visualizators system assemblies. The selected procedure should be called from the Main entry point.

Before executing the example the bubble tree looks as shown on the IVZLegends.Add interface description page. Remove legends of this bubble tree:

Sub UserProc;
Var
    Metabase: IMetabase; // Metabase
    Analyzer: IEaxAnalyzer; // Express report
    BubbleTree: IVZBubbleTree; // Bubble tree
Begin       
    // Get metabase object
    Metabase := MetabaseClass.Active;
    // Open express report
    Analyzer := Metabase.ItemById("EXP").Edit As IEaxAnalyzer;
    // Get bubble tree
    BubbleTree := Analyzer.BubbleTree.BubbleTree;
    // Delete all tree legends
    BubbleTree.Legends.Clear;
    // Save changes, made in express report
    (Analyzer As IMetabaseObject).Save; 
End Sub UserProc;

After executing the example all bubble tree legends are deleted:

Fore.NET Example

Executing the example requires that the repository contains an express report with the EXP identifier. The selected procedure is the Main entry point in the Program module of the .NET assembly. The Express, Metabase and Visualizators assemblies should be imported to this module from the Prognoz.Platform.Interop system assembly.

Before executing the example, the bubble tree looks as shown on the IVZLegends.Item interface description page. Hide the bubble tree legend:

Public Shared Sub Main(Params: StartParams);
Var
    Metabase: IMetabase; // Metabase
    Analyzer: IEaxAnalyzer; // Express report
    BubbleTree: IVZBubbleTree; // Bubble tree
Begin       
    // Get metabase object
    Metabase := Params.Metabase;
    // Open express report
    Analyzer := Metabase.ItemById["EXP"].Edit() As IEaxAnalyzer;
    // Get bubble tree
    BubbleTree := Analyzer.BubbleTree.BubbleTree;
    // Delete all tree legends
    BubbleTree.Legends.Clear();
    // Save changes, made in express report
    (Analyzer As IMetabaseObject).Save();   
End Sub;

The result of the executed example is the same as that, executed for Fore language.

See also:

IVZLegends