About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class ReferenceCurve

A reference curve is used to visualize the results from a fitting model. There are expressions defining the shape of the curve and where it begins and ends. The expressions may reference the result variables defined by the fitting model.

Since

2.0

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- ReferenceCurve

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Color Context CustomDisplayName Details DisplayName Expression IsAttached IsBackground LineStyle Name Transactions Visible Width ForEachNodeInSubTree

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): 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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from DocumentNode.Equals

Default capability

Color

get Color(): System.Drawing.Color
Gets or sets the color by which this reference curve is rendered.

Returns System.Drawing.Color
Since
2.0
set Color(value: System.Drawing.Color): void
Parameters
- value: System.Drawing.Color
Returns void

Context

get Context(): Spotfire.Dxp.Framework.DocumentModel.INodeContext
Gets the context of this node.

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

CustomDisplayName

get CustomDisplayName(): string
Gets or sets the custom display name of the reference curve.

Returns string
Since
2.0
set CustomDisplayName(value: string): void
Parameters
- value: string
Returns void

Details

get Details(): Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceDetailItemCollection
Gets the reference curve detail collection. The details are shown in tooltips or labels.

Returns Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceDetailItemCollection
Since
2.0

DisplayName

get DisplayName(): string
Gets the display name of the reference curve.

Returns string
Since
2.0

Expression

get Expression(): string
Gets the expression defining this reference curve.

Returns string
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

IsBackground

get IsBackground(): boolean
Gets or sets a value controlling if this reference curve is rendered behind other visual elements in the visualization.

Returns boolean
Since
2.0
set IsBackground(value: boolean): void
Parameters
- value: boolean
Returns void

LineStyle

get LineStyle(): Spotfire.Dxp.Application.Visuals.LineStyle
Gets or sets the line style by which this reference curve is rendered.

Returns Spotfire.Dxp.Application.Visuals.LineStyle
Since
2.0
set LineStyle(value: Spotfire.Dxp.Application.Visuals.LineStyle): void
Parameters
- value: Spotfire.Dxp.Application.Visuals.LineStyle
Returns void

Name

get Name(): string
Gets the name of the reference curve.

Returns string
Since
2.0

Transactions

get Transactions(): Spotfire.Dxp.Framework.DocumentModel.ITransactions
Gets a collection of methods for executing transactions on the document.

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Visible

get Visible(): boolean
Gets or sets a value indicating whether this reference curve is visible.

Returns boolean
Since
2.0
set Visible(value: boolean): void
Parameters
- value: boolean
Returns void

Width

get Width(): number
Gets or sets the width of this reference curve.

Returns number
Since
2.0
set Width(value: number): void
Parameters
- value: number
Returns void

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: System.Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: System.Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree