Class ReferenceLineFittingModel

Represents a horizontal or vertical reference line.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AffectAxisRanges Context DataTableDetailItemsExpression DataTableEnabled DataTableReference Enabled Expression IndividualFittingModes IsAttached IsHorizontal Line ManualUpdate Transactions TypeId UseAxisTransform GetResultsDataSource Update

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

AffectAxisRanges

  • get AffectAxisRanges(): boolean

  • Gets or sets a value indicating whether this reference line should affect the range of axes.

    Returns boolean

    Since

    2.0

  • set AffectAxisRanges(value): void

  • Parameters

    • value: boolean

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataTableDetailItemsExpression

  • 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 line's Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceDetailItemCollection will contain items corresponding to the columns specified by the expression.

    Returns string

    Since

    2.0

  • set DataTableDetailItemsExpression(value): void

  • Parameters

    • value: string

    Returns void

DataTableEnabled

  • get DataTableEnabled(): boolean

  • Gets a value indicating whether this reference line uses a data table for looking up values.

    Returns boolean

    Since

    2.0

DataTableReference

  • get DataTableReference(): DataTable

  • Gets or sets the data table.

    Returns DataTable

    Since

    2.0

  • set DataTableReference(value): void

  • Parameters

    Returns void

Enabled

Expression

  • get Expression(): string

  • Gets or sets the expression used to calculate the value to draw at. This may also be a constant value. For a horizontal line, for example use "Avg(Y)". For a vertical line, for example use "Avg(X)".

    Returns string

    Since

    2.0

  • set Expression(value): void

  • Parameters

    • value: string

    Returns void

IndividualFittingModes

  • get IndividualFittingModes(): IndividualFittingModes

  • The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination.

    Returns IndividualFittingModes

    Since

    2.0

  • set IndividualFittingModes(value): void

  • Parameters

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsHorizontal

Line

ManualUpdate

  • get ManualUpdate(): boolean

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

    Returns boolean

    Since

    2.0

  • set ManualUpdate(value): void

  • Parameters

    • value: boolean

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

TypeId

UseAxisTransform

  • get UseAxisTransform(): boolean

  • Gets or sets a value indicating whether to use the axis transform in calculations for this reference line.

    Returns boolean

    Since

    2.0

  • set UseAxisTransform(value): void

  • Parameters

    • value: boolean

    Returns void

GetResultsDataSource

Update

Settings

Member Visibility

On This Page

Methods
Default capability