Extended Result

Version

The Business Charts Panel supports the extended result object since version 5.0.0.

The extended result object allows you to return a configuration, options, and unsubscribe functions.

return {
  version: 2,
  config: { notMerge: true },
  option: {
    tooltip: {
      formatter: '{a} <br/>{b} : {c}%'
    },
    series: [
      {
        name: 'Pressure',
        type: 'gauge',
        detail: {
          formatter: '{value}'
        },
        data: [
          {
            value: 50,
            name: 'SCORE'
          }
        ]
      }
    ]
  },
  unsubscribe: () => {
    console.log('unsubscribeFunction')
  }
};

Version

The version is reserved for future improvements. The only supported version is 2.

Configuration

Option	Description	Default
notMerge	Specifies whether it's required to merge the current option with a previous one.	true
lazyUpdate	Specifies whether it's required to update the modified chart instantly or not.	false
silent	Specifies whether it's required to prevent triggering events when calling setOption.	false

Additional resources

To find more details on configuration options, please see the Apache ECharts library documentation.

Option

The option is the chart configuration in the JSON format described in the Charts Functions.

Unsubscribe

The unsubscribe section allows the addition of JavaScript code which is executed before the object is destroyed.

One of the use cases relates to unsubscription from Grafana events using an event bus.