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

Class DataLoadReport

Captured error messages during load of (typically linked) data. This can be retrieved from the Spotfire.Dxp.Data.DataManager.LoadReport.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataLoadReport

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Error Notice Section Warning Errors Items Messages Notices Sections Warnings

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

`Static`Error

Error: String

A fatal error.

Since

2.0

`Static`Notice

Notice: String

A harmless change from the original data set, such as a renamed column.

Since

2.0

`Static`Section

Section: String

A report section header.

Since

2.0

`Static`Warning

Warning: String

A non-fatal error, such as an operation failure, or a column becoming invalid.

Since

2.0

Errors

get Errors(): System.Collections.Generic.IList<string>
Gets a readonly list of all messages at the "Error" level.

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

Items

get Items(): System.Collections.Generic.IList<Item>
Gets a readonly list of all items in the report.

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

Messages

get Messages(): System.Collections.Generic.IList<string>
Gets a readonly list of all messages in the report.

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

Notices

get Notices(): System.Collections.Generic.IList<string>
Gets a readonly list of all messages at the "Notice" level.

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

Sections

get Sections(): System.Collections.Generic.IList<string>
Gets a readonly list of all report section headers.

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

Warnings

get Warnings(): System.Collections.Generic.IList<string>
Gets a readonly list of all messages at the "Warning" level.

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