Class ReferenceLineFittingModel

Represents a horizontal or vertical reference line.

Remark

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

Since

2.0

Hierarchy (View Summary)

FittingModel
- ReferenceLineFittingModel

Implements

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 FittingModel.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 FittingModel.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from FittingModel.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from FittingModel.ToString

TryCast

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

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: boolean): void
Parameters
- value: boolean
Returns void

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from FittingModel.Context

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: string): 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
Remark
Specifying either Spotfire.Dxp.Application.Visuals.FittingModels.FittingModelTypeIdentifiers.ReferenceLineFromTableFittingModel or Spotfire.Dxp.Application.Visuals.FittingModels.FittingModelTypeIdentifiers.ReferenceLineFittingModel when the model is created sets this property to true and false, respectively.

Since
2.0

DataTableReference

get DataTableReference(): DataTable
Gets or sets the data table.

Returns DataTable
Remark
This property can only be set for a reference line that was created to use data tables. This is enabled by specifying Spotfire.Dxp.Application.Visuals.FittingModels.FittingModelTypeIdentifiers.ReferenceLineFromTableFittingModel when the model is created.

Since
2.0
set DataTableReference(value: DataTable): void
Parameters
- value: DataTable
Returns void

Enabled

get Enabled(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel is enabled.

Returns boolean
Since
2.0

Inherited from FittingModel.Enabled
set Enabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FittingModel.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
Remark
The expression must evaluate to a single numeric value, thus an aggregation must be used when refering to an axis.

Since
2.0
set Expression(value: string): 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

Inherited from FittingModel.IndividualFittingModes
set IndividualFittingModes(value: IndividualFittingModes): void
Parameters
- value: IndividualFittingModes
Returns void
Inherited from FittingModel.IndividualFittingModes

IsAttached

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

Returns boolean
Since
2.0

Inherited from FittingModel.IsAttached

IsHorizontal

get IsHorizontal(): boolean
Gets or sets a value indicating whether this reference line is horizontal or vertical. The Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceLineFittingModel.Expression property will be updated to reflect the new variable.

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

Line

get Line(): ReferenceCurve
Gets the curve that renders this reference line.

Returns ReferenceCurve
Since
2.0

ManualUpdate

get ManualUpdate(): boolean
Gets or sets a value indicating whether to use manual updates.

Returns boolean
Since
2.0

Inherited from FittingModel.ManualUpdate
set ManualUpdate(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FittingModel.ManualUpdate

Transactions

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

Returns ITransactions
Since
2.0

Inherited from FittingModel.Transactions

TypeId

get TypeId(): TypeIdentifier
Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in Spotfire.Dxp.Application.Visuals.FittingModels.FittingModelTypeIdentifiers.

Returns TypeIdentifier
Since
2.0

Inherited from FittingModel.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: boolean): void
Parameters
- value: boolean
Returns void

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: 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: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from FittingModel.ForEachNodeInSubTree

GetResultsDataSource

GetResultsDataSource(): DataSource
Gets the current results as a data source.

Returns DataSource
The data source.

Since
2.0

Inherited from FittingModel.GetResultsDataSource

Update

Update(): void
Forces an update of this fitting model. Only allowed if Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel.ManualUpdate is set to true.

Returns void
Since
2.0

Inherited from FittingModel.Update

Class ReferenceLineFittingModel

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

AffectAxisRanges

Returns boolean

Since

Parameters

Returns void

Context

Returns INodeContext

Since

DataTableDetailItemsExpression

Returns string

Since

Parameters

Returns void

DataTableEnabled

Returns boolean

Remark

Since

DataTableReference

Returns DataTable

Remark

Since

Parameters

Returns void

Enabled

Returns boolean

Since

Parameters

Returns void

Expression

Returns string

Remark

Since

Parameters

Returns void

IndividualFittingModes

Returns IndividualFittingModes

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

IsHorizontal

Returns boolean

Since

Parameters

Returns void

Line

Returns ReferenceCurve

Since

ManualUpdate

Returns boolean

`Static`Equals