Package com.inductiveautomation.sfc.api

Interface ChartManagerService

All Superinterfaces:
ModuleService
public interface ChartManagerService extends ModuleService

  • Method Details

    • register

      void register(StepFactory factory)
      Register a StepFactory.
      Parameters:
      factory - The StepFactory to register.

    • unregister

      void unregister(StepFactory factory)
      Unregister a StepFactory.
      Parameters:
      factory - The StepFactory to unregister.

    • registerScopeLocator

      void registerScopeLocator(ScopeLocator locator)
      Register a ScopeLocator, which will be used by expressions and scripting functions to resolve special scopes provided or identified by modules.

    • unregisterScopeLocator

      void unregisterScopeLocator(ScopeLocator locator)
      Unregister a previously registered scope locator.

    • startChart

      UUID startChart(String projectName, String chartPath, Map<String,Object> parameters, String user) throws Exception
      Start an instance of the chart defined at chartPath.
      Parameters:
      projectName - the name of the Project the chart is defined in.
      chartPath - the path to the chart in Project projectName.
      parameters - the parameters to be made available start in the chart's scope.
      user - the user requesting the chart be started.
      Returns:
      the UUID of the chart instance.
      Throws:
      Exception - if the chart cannot be started for any reason.

    • cancelChart

      void cancelChart(UUID instanceId)
      Cancel the chart instance identified by instanceId.
      Parameters:
      instanceId - the instance id of the chart to cancel.

    • pauseChart

      void pauseChart(UUID instanceId)
      Pause the chart instance identified by instanceId.
      Parameters:
      instanceId - the instance id of the chart to pause.

    • resumeChart

      void resumeChart(UUID instanceId)
      Resume the chart instance identified by instanceId.
      Parameters:
      instanceId - the instance id of the chart to resume.

    • addChartObserver

      void addChartObserver(ChartObserver observer)
      Registers a ChartObserver that will be notified of chart and element events that occur.

    • removeChartObserver

      void removeChartObserver(ChartObserver observer)
      Removes a previously registered ChartObserver.