AnalyticsCatView.getLegendButton

Syntax

getLegendButton();

Description

The getLegendButton method returns the validation legend button.

Example

Executing the example requires that the HTML page contains the ExpressBox component named expressBox (see Example of Creating the ExpressBox Component). Open the Advanced Analytics tab in the report and enter the following code in the console:

// Get tool ribbon
ribbon = expressBox.getRibbonView();
// Get the Advanced Analytics tab
analyticCat = ribbon.getAnalyticsCategory();
// Get legend tab
analyticCat.getLegendButton();
// -> PP.Ui.RibbonButton {_IsLargeControl: false, _Events: Object, _typeName: "PP.Ui.RibbonButton", ContentChanged: PP.Delegate, _IsRTL: false…}

After executing the example a validation legend button is obtained.