Class FittingModelConfigurator

Provides methods for configuring the fitting model during the Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel.ConfigureModelCore|ConfigureModelCore(configurator).

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AddDefaultDetails AddDetail RegisterResultVariable SetCurveExpression SetCurveExpressions SetPointExpressions

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

AddDefaultDetails

AddDetail

RegisterResultVariable

  • RegisterResultVariable(name, description): void

  • Registers a new result variable with the fitting model.

    Parameters

    • name: string | String

      The name.

    • description: string | String

      The description.

    Returns void

    Since

    2.0

SetCurveExpression

  • SetCurveExpression(curve, expression): void

  • Sets the curve expression.

    Parameters

    Returns void

    Since

    2.0

SetCurveExpressions

  • SetCurveExpressions(curve, expression, beginExpression, endExpression): void

  • Sets the curve expressions, including begin and end expressions.

    Parameters

    • curve: ReferenceCurve

      The curve.

    • expression: string | String

      The expression defining the curve.

    • beginExpression: string | String

      The begin expression. Specifying the value where the reference curve should begin.

    • endExpression: string | String

      The end expression. Specifying the value where the reference curve should end.

    Returns void

    Since

    2.0

SetPointExpressions

  • SetPointExpressions(point, xExpression, yExpression): void

  • Sets the point expressions.

    Parameters

    • point: ReferencePoint

      The ReferencePoint on which to set the expressions.

    • xExpression: string | String

      An expression that evaluates to the x coordinate of the point.

    • yExpression: string | String

      An expression that evaluates to the y coordinate of the point.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability