Package com.inductiveautomation.sfc.api

Interface ScopeLocator

All Superinterfaces:
CommonScopes
public interface ScopeLocator extends CommonScopes
The ScopeLocator system provides an extensible mechanism for module authors to provide new scopes, or locate virtual scopes.

They are registered with the chart manager, and then are called any time a scope must be calculated, such as in expression bindings (like "{opscope.identifier}") or through the script context such as "context.resolve('opscope')".

  • Field Summary

    Fields inherited from interface com.inductiveautomation.sfc.api.CommonScopes

    CHART, PARENT, PREVIOUS, ROOT, STEP

  • Method Summary

    Modifier and Type
    Method
    Description
    PyChartScope
    locate(ScopeContext scopeContext, String identifier)
    Attempts to locate the scope identified by the identifier, provided the current "scope context".

  • Method Details

    • locate

      @Nullable PyChartScope locate(ScopeContext scopeContext, String identifier)
      Attempts to locate the scope identified by the identifier, provided the current "scope context". A scope context is a collection of scopes relative to the particular location.

      If this locator cannot resolve the identifier, it should simply return null.

      Returns:
      the located scope, or null if the identifier is not found.