IVZColorLegendBase.BetweenFormat

Syntax

BetweenFormat: Variant;

Description

The BetweenFormat property determines format of record for intervals with both borders.

Comments

To determine a label for visualizer element corresponding to missing data, use IVZColorLegendBase.NoDataText.

Example

Executing the example requires that the repository contains an express report with the EXPRESS_IVZCOLORLEGENDBASE identifier.

Add links to the Express, Metabase, Visualizators system assemblies.

Sub UserProc;
Var
    Metabase: IMetabase;
    Analyzer: IEaxAnalyzer;
    BubbleTree: IVZBubbleTree;
    ColorLegend: IVZColorLegendBase;
Begin
    // Get repository
    Metabase := MetabaseClass.Active;
    // Get express report
    Analyzer := Metabase.ItemById("Express_IVZColorLegendBase").Edit As IEaxAnalyzer;
    // Get bubble tree
    BubbleTree := Analyzer.BubbleTree.BubbleTree;
    // Get color legend of tree
    ColorLegend := BubbleTree.Legends.Item(0) As IVZColorLegendBase;
    // Determine format of record for intervals with both borders
    ColorLegend.BetweenFormat := "{0:0.00} - {1:0.00}";
    // Determine format of record for intervals with left border
    ColorLegend.GreaterFormat := "From {0:0.00}";
    // Determine format of record for intervals with right border
    ColorLegend.LessFormat := "To {0:0.00}";
    // Display a bubble corresponding to missing data
    ColorLegend.NoDataVisible := True;
    // Set label for this bubble
    ColorLegend.NoDataText := "No" data available";
    // Place this bubble before other bubbles
    ColorLegend.NoDataPosition := VisualizatorNoDataPosition.Before;
    // Save changes
    (Analyzer As IMetabaseObject).Save;
End Sub UserProc;

After executing the example, the format of record for bubble tree scale intervals with both borders is determined as "{0:0.00} - {1:0.00}", for interval with left border is "From {0:0.00}", for interval with right border is "To {0:0.00}". The bubble that corresponds to missing data is renamed as "No data", and placed before other tree bubbles: