IVZColorLegendBase.Scale

Fore Syntax

Fore.NET Syntax

Scale: Prognoz.Platform.Interop.Visualizators.VZDataScale;

Description

The Scale property determines a scale for visualizer color legend.

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 color scale of bubble tree looks as shown on the IVZColorLegendBase interface description page. Set two elements for this scale:

Sub UserProc;
Var
    Metabase: IMetabase; // Metabase
    Analyzer: IEaxAnalyzer; // Express report
    BubbleTree: IVZBubbleTree; // Bubble tree
    ColorLegend: IVZColorLegendBase; // Color legend
    Scale: IVZDataScale; // Color legend scale
Begin
    // Get metabase object
    Metabase := MetabaseClass.Active;
    // Get express report object
    Analyzer := Metabase.ItemById("EXP").Edit As IEaxAnalyzer;
    // Get bubble tree
    BubbleTree := Analyzer.BubbleTree.BubbleTree;
    // Get color legend of bubble tree
    ColorLegend := BubbleTree.Legends.Item(0) As IVZColorLegendBase;
    // Disable displaying of the "No Data" element
    ColorLegend.NoDataVisible := False;
    // Get color legend scale
    Scale := ColorLegend.Scale;
    // Determine the number of elements equal to two
    Scale.ItemsCount := 2;
    // Save changes, made in express report
    (Analyzer As IMetabaseObject).Save;
End Sub UserProc;

After executing the example the number of scale items that is equal to two is set for bubble tree color legend, and displaying of the No Data element is also disabled:

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 color scale of bubble tree looks as shown on the IVZColorLegendBase interface description page. Set two elements for this scale:

Public Shared Sub Main(Params: StartParams);
Var
    Metabase: IMetabase; // Metabase
    Analyzer: IEaxAnalyzer; // Express report
    BubbleTree: IVZBubbleTree; // Bubble tree
    ColorLegend: IVZColorLegendBase; // Color legend
    Scale: IVZDataScale; // Color legend scale
Begin
    // Get metabase object
    Metabase := Params.Metabase;
    // Get express report object
    Analyzer := Metabase.ItemById["EXP"].Edit() As IEaxAnalyzer;
    // Get bubble tree
    BubbleTree := Analyzer.BubbleTree.BubbleTree;
    // Get color legend of bubble tree
    ColorLegend := BubbleTree.Legends.Item[0] As IVZColorLegendBase;
    // Disable displaying of the "No Data" element
    ColorLegend.NoDataVisible := False;
    // Get color legend scale
    Scale := ColorLegend.Scale;
    // Determine number of elements that equals to 2
    Scale.ItemsCount := 2;
    // 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.