system.sfc.cancelChart

Description

Cancels the execution of a running chart instance. Any running steps will be told to stop, and the chart will enter Canceling state.

Syntax

system.sfc.cancel Chart (id)

  • Parameters

id -The ID of the chart instance to cancel

  • Returns

Nothing

  • Scope

All

  • Throws

Will throw a KeyError if the ID does not match any running chart instance.

Code Examples
Code Snippet
#The following will attempt to stop an SFC but will alert the user if the id of the chart is not currently running
id = 'Some long string value obtained from earlier in the script'
try:
system.sfc.cancelChart(id)
except:
system.gui.messageBox("Could not stop the SFC")