PP.Ui.ConfigClass.getChart

Syntax

getChart ();

Description

The getChart method returns chart parameters.

Comments

The method returns a JSON object with the following fields:

Field name Type Brief description
Animation Boolean Determines whether series animation is used on rebuilding the chart. Available values:
  • true. Animation is enabled.

  • false. Animation is disabled (default).

ShowLoadConfirm Boolean Determines whether to show a notice concerning possible time-consuming load, if the chart contains a large amount of points. Available values:
  • true. Warning is displayed (default).

  • false. Animation is disabled.

EnableCanvas Boolean Determines whether the Canvas element is used to render a chart: Available values:
  • true. Used.

  • false. Not used (default).

Field values can be set using the set<Field name> method, and obtained using the get<Field name> method.

Example

The following code is executed in the browser console on the page of Foresight Analytics Platform standard web application with open express report, workbook or dashboard.

//Get web application settings
conf = PP.Ui.getConfig();
//Enable chart animation
conf.getChart().setAnimation(True);

After executing the example chart of the open report is rendered using animation.

See also:

PP.Ui.ConfigClass