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

Class CalculationSettingsValidationResult

Report from the Spotfire.Dxp.Application.Calculations.CalculationSettings validation. Contains any errors or warnings that this resulted in. These can then be displayed to the user or added to if the implementation wants to do additional checks.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- CalculationSettingsValidationResult

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Errors IsValid Warnings AddError AddWarning

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

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.

Inherited from Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.ToString

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

`Static`Equals

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.

Inherited from Object.Equals

Default capability

Errors

get Errors(): System.Collections.Generic.IList<string>
Errors found

Returns System.Collections.Generic.IList<string>
Since
2.0

IsValid

get IsValid(): boolean
If the settings are valid input to run a calculation on.

Returns boolean
Since
2.0

Warnings

get Warnings(): System.Collections.Generic.IList<string>
Warnings given

Returns System.Collections.Generic.IList<string>
Since
2.0

AddError

AddError(error): void
Add new error
Parameters
- error: string | String
  The error string.
Returns void
Since
2.0

AddWarning

AddWarning(warning): void
Add new warning
Parameters
- warning: string | String
  The warning string.
Returns void
Since
2.0