Class DataValueCollection

A collection of the row values in a Spotfire.Dxp.Data.IDataColumn.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataValueCollection

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Comparer Count DataType Formatter InvalidRows ValidRows FindNumericRange FindRowsInNumericRange GetEnumerator GetMaxNumericValue GetMaxValue GetMinNumericValue GetMinValue

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 Object.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 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: 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 Object.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 Object.Equals

Default capability

Comparer

get Comparer(): System.Collections.IComparer
Gets the comparer which should be used to compare row values.

Returns System.Collections.IComparer
Since
2.0

Count

get Count(): number
Gets the number of values in the collection.

Returns number
Since
2.0

DataType

get DataType(): DataType
Gets the data type of the values in the collection.

Returns DataType
Since
2.0

Formatter

get Formatter(): IDataFormatter
Gets the formatter which should be used for format row values..

Returns IDataFormatter
Since
2.0

InvalidRows

get InvalidRows(): IndexSet
Gets the invalid rows in the collection, as an Spotfire.Dxp.Data.IndexSet.

Returns IndexSet
Since
2.0

ValidRows

get ValidRows(): IndexSet
Gets the valid rows in the collection, as an Spotfire.Dxp.Data.IndexSet.

Returns IndexSet
Since
2.0

FindNumericRange

FindNumericRange(rowIndexes: IndexSet): Range
Finds the minimum and maximum numeric values in a subset of the rows.
Parameters
- rowIndexes: IndexSet
  The row indexes.
Returns Range
The minimum and maximum as a Spotfire.Dxp.Data.Range.

Since
2.0

FindRowsInNumericRange

FindRowsInNumericRange(range: Range, includeEmpty: boolean | Boolean): IndexSet
Finds all rows with values in a given numeric range.
Parameters
- range: Range
  A numeric Spotfire.Dxp.Data.Range.
- includeEmpty: boolean | Boolean
  If true, include invalid values; otherwise, do not.
Returns IndexSet
The indexes of the found rows, as an Spotfire.Dxp.Data.IndexSet.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataValue>
Enumerate over all the data value in the collection.

Returns System.Collections.Generic.IEnumerator<DataValue>
An enumerator over all values in the collection.

Since
2.0

GetMaxNumericValue

GetMaxNumericValue(
    rowIndexes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | Int32>,
    >,
): DataValueGeneric<number>
Gets the maximum numeric value in a subset of the rows.
Parameters
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  The subset of the rows.
Returns DataValueGeneric<number>
The maximum numeric value.

Since
2.0

GetMaxValue

GetMaxValue(): DataValue
Gets the maximum value of all the rows.

Returns DataValue
The maximum value.

Since
2.0
GetMaxValue(
    rowIndexes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | Int32>,
    >,
): DataValue
Gets the maximum value in a subset of the rows.
Parameters
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  The subset of the rows.
Returns DataValue
The maximum value.

Since
2.0

GetMinNumericValue

GetMinNumericValue(
    rowIndexes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | Int32>,
    >,
): DataValueGeneric<number>
Gets the minimum numeric value within in a subset of the rows.
Parameters
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  The subset of the rows.
Returns DataValueGeneric<number>
The minimum numeric value.

Since
2.0

GetMinValue

GetMinValue(): DataValue
Gets the minimum value of all the rows.

Returns DataValue
The minimum value.

Since
2.0
GetMinValue(
    rowIndexes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | Int32>,
    >,
): DataValue
Gets the minimum value in a subset of the rows.
Parameters
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>
  The subset of the rows.
Returns DataValue
The minimum value.

Since
2.0

Class DataValueCollection

Since

Hierarchy (View Summary)

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

Comparer

Returns System.Collections.IComparer

Since

Count

Returns number

Since

DataType

Returns DataType

Since

Formatter

Returns IDataFormatter

Since

InvalidRows

Returns IndexSet

Since

ValidRows

Returns IndexSet

Since

FindNumericRange

Parameters

Returns Range

Since

FindRowsInNumericRange

Parameters

Returns IndexSet

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<DataValue>

Since

GetMaxNumericValue

Parameters

Returns DataValueGeneric<number>

Since

GetMaxValue

Returns DataValue

Since

Parameters

Returns DataValue

Since

GetMinNumericValue

Parameters

Returns DataValueGeneric<number>

Since

GetMinValue

Returns DataValue

Since

Parameters

Returns DataValue

Since

Settings

On This Page

`Static`Equals