This function is used in Python Scripting.

Description

Pauses a running chart instance. Any running steps will be told to pause, and the chart will enter paused state. Will throw a KeyError if the ID does not match any running chart instance.

Client Permission Restrictions

Permission Type: SFC Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax

system.sfc.pauseChart(id)

  • Parameters

String id - The ID of the chart instance to pause

  • Returns

Nothing

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples

There are no code examples for this function.


Keywords

system sfc pauseChart, sfc.pauseChart