Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style, syntax
Scripting_function


Panel
titleDescription

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

Panel
titleClient 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.

Panel
titleSyntax

system.sfc.pauseChart(id)

  • Parameters

String id - The ID of the chart instance to pause

  • Returns

Nothing

  • Scope

Gateway, Vision Client, Perspective Session

  • Throws

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

Panel
titleCode Examples

There are There are no code examples associated with for this scripting function.


Panel
titleKeywords

system sfc pauseChart, sfc.pauseChart