Action
    Preparing search index...

    Class ReferenceCurveFittingModel

    Used to display a reference curve. The shape of the curve is defined by an expression. The expression may reference the variable x and column names in the data table defined by Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceCurveFittingModel.DataTableReference.

    This class cannot be inherited. See the Spotfire.Dxp.Application.Extension.CustomFittingModel class for creating custom fitting models.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    BeginExpression Context Curve DataTableDetailItemsExpression DataTableEnabled DataTableReference Enabled EndExpression Expression IndividualFittingModes IsAttached LimitToMarking ManualUpdate Transactions TypeId ForEachNodeInSubTree GetResultsDataSource Update

    Methods

    • 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

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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 T1 | null

    • 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

    • get BeginExpression(): string

      Gets or sets the expression defining where this reference curve begins.

      Returns string

      This is typically set to a constant value. If the expression is empty or evaluates to null, the curve will extend to the low end of the x-axis range.

      2.0

    • set BeginExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DataTableDetailItemsExpression(): string

      Gets or sets an expression specifying which columns in the current data table to make available to labels and tooltips. When this property is set, the curve's Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceDetailItemCollectionwill contain items corresponding to the columns specified by the expression.

      Returns string

      2.0

    • set DataTableDetailItemsExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get Enabled(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel is enabled.

      Returns boolean

      2.0

    • set Enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get EndExpression(): string

      Gets or sets the expression defining where this reference curve ends.

      Returns string

      This is typically set to a constant value. If the expression is empty or evaluates to null, the curve will extend to the high end of the x-axis range.

      2.0

    • set EndExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get Expression(): string

      Gets or sets the expression defining this curve.

      Returns string

      2.0

    • set Expression(value: string): void

      Parameters

      • value: string

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LimitToMarking(): boolean

      Gets or sets a value indicating whether the fitting model should only include marked data when fitting. When true the active marking from the owning visual will limit the data used to perform the curve fit. Note that for some fitting model that don't use the visualization data, this property has no effect.

      Returns boolean

      2.5

    • set LimitToMarking(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ManualUpdate(): boolean

      Gets or sets a value indicating whether to use manual updates.

      Returns boolean

      2.0

    • set ManualUpdate(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability