IVZColorLegendBase.DoHighlight

Syntax

DoHighlight: Boolean;

Description

The DoHighlight property determines whether color scale elements can be highlighted.

Comments

The property is set to True if highlighting of color scale elements is enabled, and False if highlighting of color scale elements is disabled. Default value is False.

To determine highlighting color for legend elements, use the IVZColorLegendBase.HighlightBrush property.

To set the action, executing of which highlights a legend element, use the IVZColorLegendBase.HoverMode property.

Example

Executing the example requires that the repository contains an express report with the EXPRESS identifier containing a bubble tree.

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

Sub UserProc;
Var
    Metabase: IMetabase;
    Analyzer: IEaxAnalyzer;
    BubbleTree: IVZBubbleTree;
    ColorLegend: IVZColorLegendBase;
    Brush: IGxBrush;
Begin
    // Get the current repository
    Metabase := MetabaseClass.Active;
    // Get express report
    Analyzer := Metabase.ItemById("EXPRESS").Edit As IEaxAnalyzer;
    // Get bubble tree
    BubbleTree := Analyzer.BubbleTree.BubbleTree;
    // Get color legend of bubble tree
    ColorLegend := BubbleTree.Legends.Item(0) As IVZColorLegendBase;
    // Enable highlighting of scale items
    ColorLegend.DoHighlight := True;
    // Select brush
    Brush := New GxSolidBrush.Create(New GxColor.CreateRGB(202, 218, 186));
    ColorLegend.HighlightBrush := Brush;
    // Determine legend element selection mode - on mouse click
    ColorLegend.HoverMode := VisualizatorHoverMode.Click;
    // Save changes made in express report
    (Analyzer As IMetabaseObject).Save; 
End Sub UserProc;

After executing the example the clicked legend element is highlighted with the specified color in the express report.

See also:

IVZColorLegendBase