Class IEvaluator

An Evaluator is one of two scripts that may be assigned to 3D components. While Interactors control the run-time behavior and run on client-side, Evaluators create component hierarchies and primarily run server-side.

This interface should be implemented by each Evaluator class.

Hierarchy

Implemented by

Constructors

Methods

Constructors

Methods

  • Creates a construction list containing Components, Interactors, Layers, etc. This is a required function.

    Returns

    An evaluator response.

    All formulas and expressions returned by the Evaluator must be resolved!

    Parameters

    • productId: string

      The product name/identification linking to the product definition in the database. Usually evaluators do not consider this.

    • path: string

      The relative structure path of the component to be created. Usually, the calling environment creates a component and--after calling the evaluator's Create() function--merges the returned component response. Any component created this way, must have a Path relative to path</>.

    • parameters: {
          [parameter: string]: any;
      }

      An object with key-value pairs to parameterize the creation process.
      A parameter value may be a string, even if it primarily is a boolean or a number. Please make sure that you always support also the string representation. We recommend to use the IGX.Eval getters, because they already support this and also implement an optional default value.

      • [parameter: string]: any

    Returns EvalResponse

Generated using TypeDoc